diff --git a/website/versioned_docs/version-2.5/01_introduction/code/03_input_async.py b/website/versioned_docs/version-2.5/01_introduction/code/03_input_async.py index 1937f446..bef7ac72 100644 --- a/website/versioned_docs/version-2.5/01_introduction/code/03_input_async.py +++ b/website/versioned_docs/version-2.5/01_introduction/code/03_input_async.py @@ -12,5 +12,5 @@ async def main() -> None: 'some': 'input', } - # Start an Actor and wait for it to finish. + # Start an Actor and waits for it to finish. call_result = await actor_client.call(run_input=run_input) diff --git a/website/versioned_docs/version-2.5/01_introduction/code/03_input_sync.py b/website/versioned_docs/version-2.5/01_introduction/code/03_input_sync.py index 6a27dd39..7fab1635 100644 --- a/website/versioned_docs/version-2.5/01_introduction/code/03_input_sync.py +++ b/website/versioned_docs/version-2.5/01_introduction/code/03_input_sync.py @@ -12,5 +12,5 @@ def main() -> None: 'some': 'input', } - # Start an Actor and wait for it to finish. + # Start an Actor and waits for it to finish. call_result = actor_client.call(run_input=run_input) diff --git a/website/versioned_docs/version-2.5/01_introduction/index.mdx b/website/versioned_docs/version-2.5/01_introduction/index.mdx index ab1ae5a7..f4bb1ab1 100644 --- a/website/versioned_docs/version-2.5/01_introduction/index.mdx +++ b/website/versioned_docs/version-2.5/01_introduction/index.mdx @@ -1,8 +1,9 @@ --- id: introduction title: Overview +sidebar_label: Overview slug: / -description: The official Python library to access the Apify API, with automatic retries, async support, and comprehensive API coverage. +description: "The official Python library to access the Apify API, with automatic retries, async support, and comprehensive API coverage." --- import Tabs from '@theme/Tabs'; @@ -23,7 +24,7 @@ The client simplifies interaction with the Apify platform by providing: ## Prerequisites -`apify-client` requires Python 3.11 or higher. Python is available for download on the [official website](https://www.python.org/downloads/). Check your current Python version by running: +`apify-client` requires Python 3.10 or higher. Python is available for download on the [official website](https://www.python.org/downloads/). Check your current Python version by running: ```bash python --version @@ -39,7 +40,7 @@ pip install apify-client ## Quick example -The following example shows how to run an Actor and retrieve its results: +Here's an example showing how to run an Actor and retrieve its results: diff --git a/website/versioned_docs/version-2.5/01_introduction/quick-start.mdx b/website/versioned_docs/version-2.5/01_introduction/quick-start.mdx index 7083c16c..7365e56e 100644 --- a/website/versioned_docs/version-2.5/01_introduction/quick-start.mdx +++ b/website/versioned_docs/version-2.5/01_introduction/quick-start.mdx @@ -1,7 +1,8 @@ --- id: quick-start title: Quick start -description: Get started with the Apify API client for Python by running an Actor and retrieving results from its dataset. +sidebar_label: Quick start +description: "Get started with the Apify API client for Python by running an Actor and retrieving results from its dataset." --- import Tabs from '@theme/Tabs'; diff --git a/website/versioned_docs/version-2.5/02_concepts/01_async_support.mdx b/website/versioned_docs/version-2.5/02_concepts/01_async_support.mdx index 1d7efa13..dbd7679d 100644 --- a/website/versioned_docs/version-2.5/02_concepts/01_async_support.mdx +++ b/website/versioned_docs/version-2.5/02_concepts/01_async_support.mdx @@ -1,7 +1,6 @@ --- id: asyncio-support title: Asyncio support -description: Use the async client for non-blocking API calls with Python asyncio. --- import Tabs from '@theme/Tabs'; @@ -11,12 +10,10 @@ import ApiLink from '@theme/ApiLink'; import AsyncSupportExample from '!!raw-loader!./code/01_async_support.py'; -The package provides an asynchronous version of the client, `ApifyClientAsync`, which allows you to interact with the Apify API using Python's standard async/await syntax. This enables you to perform non-blocking operations, see the Python [asyncio documentation](https://docs.python.org/3/library/asyncio-task.html) for more information. This is useful for applications that need to perform multiple API operations concurrently or integrate with other async frameworks. +The package provides an asynchronous version of the client, `ApifyClientAsync`, which allows you to interact with the Apify API using Python's standard async/await syntax. This enables you to perform non-blocking operations, see the Python [asyncio documentation](https://docs.python.org/3/library/asyncio-task.html) for more information. -The following example shows how to run an Actor asynchronously and stream its logs while it is running: +The following example demonstrates how to run an Actor asynchronously and stream its logs while it is running: {AsyncSupportExample} - -For the full async client API, see the `ApifyClientAsync` reference. diff --git a/website/versioned_docs/version-2.5/02_concepts/02_single_collection_clients.mdx b/website/versioned_docs/version-2.5/02_concepts/02_single_collection_clients.mdx index 1cdadc50..e53e5ecf 100644 --- a/website/versioned_docs/version-2.5/02_concepts/02_single_collection_clients.mdx +++ b/website/versioned_docs/version-2.5/02_concepts/02_single_collection_clients.mdx @@ -1,7 +1,6 @@ --- id: single-and-collection-clients title: Single and collection clients -description: Understand the two types of resource clients, single-resource and collection clients. --- import Tabs from '@theme/Tabs'; @@ -15,7 +14,7 @@ import CollectionSyncExample from '!!raw-loader!./code/02_collection_sync.py'; import SingleAsyncExample from '!!raw-loader!./code/02_single_async.py'; import SingleSyncExample from '!!raw-loader!./code/02_single_sync.py'; -The Apify client provides two types of resource clients: single-resource clients for managing an individual resource, and collection clients for listing or creating resources. +The Apify client interface is designed to be consistent and intuitive across all of its components. When you call specific methods on the main client, you create specialized clients to manage individual API resources. There are two main types of clients: - `ActorClient` - Manages a single resource. - `ActorCollectionClient` - Manages a collection of resources. diff --git a/website/versioned_docs/version-2.5/02_concepts/03_nested_clients.mdx b/website/versioned_docs/version-2.5/02_concepts/03_nested_clients.mdx index 95e512d1..56a9e152 100644 --- a/website/versioned_docs/version-2.5/02_concepts/03_nested_clients.mdx +++ b/website/versioned_docs/version-2.5/02_concepts/03_nested_clients.mdx @@ -1,7 +1,6 @@ --- id: nested-clients title: Nested clients -description: Access related resources directly through nested client methods. --- import Tabs from '@theme/Tabs'; @@ -13,7 +12,7 @@ import ApiLink from '@theme/ApiLink'; import NestedAsyncExample from '!!raw-loader!./code/03_nested_async.py'; import NestedSyncExample from '!!raw-loader!./code/03_nested_sync.py'; -Nested clients let you access related resources directly from a parent resource client, without manually constructing new client instances. +In some cases, the Apify client provides nested clients to simplify working with related collections. For example, you can easily manage the runs of a specific Actor without having to construct multiple endpoints or client instances manually. diff --git a/website/versioned_docs/version-2.5/02_concepts/04_error_handling.mdx b/website/versioned_docs/version-2.5/02_concepts/04_error_handling.mdx index 5eb1b4d0..89eb543a 100644 --- a/website/versioned_docs/version-2.5/02_concepts/04_error_handling.mdx +++ b/website/versioned_docs/version-2.5/02_concepts/04_error_handling.mdx @@ -1,7 +1,6 @@ --- id: error-handling title: Error handling -description: Handle API errors with the ApifyApiError exception and automatic data parsing. --- import Tabs from '@theme/Tabs'; @@ -14,22 +13,6 @@ import ErrorSyncExample from '!!raw-loader!./code/04_error_sync.py'; When you use the Apify client, it automatically extracts all relevant data from the endpoint and returns it in the expected format. Date strings, for instance, are seamlessly converted to Python `datetime.datetime` objects. If an error occurs, the client raises an `ApifyApiError`. This exception wraps the raw JSON errors returned by the API and provides additional context, making it easier to debug any issues that arise. -## Error subclasses - -The Apify client provides dedicated error subclasses based on the HTTP status code of the failed response, so you can branch on error kind without inspecting `status_code` or `type`: - -| Status | Subclass | -|---|---| -| 400 | `InvalidRequestError` | -| 401 | `UnauthorizedError` | -| 403 | `ForbiddenError` | -| 404 | `NotFoundError` | -| 409 | `ConflictError` | -| 429 | `RateLimitError` | -| 5xx | `ServerError` | - -All subclasses inherit from `ApifyApiError`, so an existing `except ApifyApiError` handler still catches every API error. Catch a specific subclass when you want to react differently to, for example, a missing resource or a rate-limit: - @@ -42,5 +25,3 @@ All subclasses inherit from `ApifyApiError` - -For a complete list of error classes, see the `ApifyApiError` reference. diff --git a/website/versioned_docs/version-2.5/02_concepts/05_retries.mdx b/website/versioned_docs/version-2.5/02_concepts/05_retries.mdx index dfdf0917..d7d99a29 100644 --- a/website/versioned_docs/version-2.5/02_concepts/05_retries.mdx +++ b/website/versioned_docs/version-2.5/02_concepts/05_retries.mdx @@ -1,7 +1,6 @@ --- id: retries title: Retries -description: Configure automatic retries with exponential backoff for failed requests. --- import Tabs from '@theme/Tabs'; @@ -13,13 +12,13 @@ import ApiLink from '@theme/ApiLink'; import RetriesAsyncExample from '!!raw-loader!./code/05_retries_async.py'; import RetriesSyncExample from '!!raw-loader!./code/05_retries_sync.py'; -The Apify client automatically retries requests that fail due to: +When dealing with network communication, failures can occasionally occur. The Apify client automatically retries requests that fail due to: - Network errors - Internal errors in the Apify API (HTTP status codes 500 and above) - Rate limit errors (HTTP status code 429) -By default, the client retries a failed request up to 4 times. The retry intervals use an exponential backoff strategy: +By default, the client will retry a failed request up to 8 times. The retry intervals use an exponential backoff strategy: - The first retry occurs after approximately 500 milliseconds. - The second retry occurs after approximately 1,000 milliseconds, and so on. @@ -27,9 +26,9 @@ By default, the client retries a failed request up to 4 times. The retry interva You can customize this behavior using the following options in the `ApifyClient` constructor: - `max_retries`: Defines the maximum number of retry attempts. -- `min_delay_between_retries`: Sets the minimum delay between retries as a `timedelta`. +- `min_delay_between_retries_millis`: Sets the minimum delay between retries (in milliseconds). -Retries with exponential backoff help reduce the load on the server and increase the chances of a successful request. +Retries with exponential backoff are a common strategy for handling network errors. They help to reduce the load on the server and increase the chances of a successful request. diff --git a/website/versioned_docs/version-2.5/02_concepts/06_logging.mdx b/website/versioned_docs/version-2.5/02_concepts/06_logging.mdx index 4b4e8ed5..2e495878 100644 --- a/website/versioned_docs/version-2.5/02_concepts/06_logging.mdx +++ b/website/versioned_docs/version-2.5/02_concepts/06_logging.mdx @@ -1,7 +1,6 @@ --- id: logging title: Logging -description: Configure debug logging to inspect API requests and responses. --- import Tabs from '@theme/Tabs'; diff --git a/website/versioned_docs/version-2.5/02_concepts/07_convenience_methods.mdx b/website/versioned_docs/version-2.5/02_concepts/07_convenience_methods.mdx index 24a25593..3ad81405 100644 --- a/website/versioned_docs/version-2.5/02_concepts/07_convenience_methods.mdx +++ b/website/versioned_docs/version-2.5/02_concepts/07_convenience_methods.mdx @@ -1,7 +1,6 @@ --- id: convenience-methods title: Convenience methods -description: Use high-level methods for running Actors, waiting for results, and accessing data. --- import Tabs from '@theme/Tabs'; @@ -15,9 +14,8 @@ import CallSyncExample from '!!raw-loader!./code/07_call_sync.py'; The Apify client provides several convenience methods to handle actions that the API alone cannot perform efficiently, such as waiting for an Actor run to finish without running into network timeouts. These methods simplify common tasks and enhance the usability of the client. -- `ActorClient.call` - Starts an Actor and waits for it to finish, handling network timeouts internally. Waits indefinitely by default, or up to the specified `wait_duration`. -- `ActorClient.start` - Starts an Actor and immediately returns the Run object without waiting for it to finish. -- `RunClient.wait_for_finish` - Waits for an already-started run to reach a terminal status. +- `ActorClient.call` - Starts an Actor and waits for it to finish, handling network timeouts internally. +- `ActorClient.start` - Explicitly waits for an Actor run to finish with customizable timeouts. Additionally, storage-related resources offer flexible options for data retrieval: @@ -36,7 +34,3 @@ Additionally, storage-related resources offer flexible options for data retrieva - -:::tip -The `call()` method polls internally and may take a long time for long-running Actors. Use `start()` and `wait_for_finish()` separately if you need more control over the waiting behavior. -::: diff --git a/website/versioned_docs/version-2.5/02_concepts/08_pagination.mdx b/website/versioned_docs/version-2.5/02_concepts/08_pagination.mdx index 880f6c0c..6747d7ee 100644 --- a/website/versioned_docs/version-2.5/02_concepts/08_pagination.mdx +++ b/website/versioned_docs/version-2.5/02_concepts/08_pagination.mdx @@ -1,7 +1,6 @@ --- id: pagination title: Pagination -description: Paginate through large result sets using page models or generator-based iteration. --- import Tabs from '@theme/Tabs'; @@ -12,12 +11,8 @@ import ApiLink from '@theme/ApiLink'; import PaginationAsyncExample from '!!raw-loader!./code/08_pagination_async.py'; import PaginationSyncExample from '!!raw-loader!./code/08_pagination_sync.py'; -import IterateItemsAsyncExample from '!!raw-loader!./code/08_iterate_items_async.py'; -import IterateItemsSyncExample from '!!raw-loader!./code/08_iterate_items_sync.py'; -import IterateCollectionAsyncExample from '!!raw-loader!./code/08_iterate_collection_async.py'; -import IterateCollectionSyncExample from '!!raw-loader!./code/08_iterate_collection_sync.py'; -Most methods named `list` or `list_something` in the Apify client return a page model — a [Pydantic](https://docs.pydantic.dev/latest/) model such as `ListOfActors`, `ListOfDatasets`, or `ListOfRequests`. Unstructured dataset items use the `DatasetItemsPage` dataclass instead. All page models share a consistent interface for working with paginated data and expose the following fields: +Most methods named `list` or `list_something` in the Apify client return a `ListPage` object. This object provides a consistent interface for working with paginated data and includes the following properties: - `items` - The main results you're looking for. - `total` - The total number of items available. @@ -25,9 +20,9 @@ Most methods named `list` or `list_something` in the Apify client return a page - `count` - The number of items in the current page. - `limit` - The maximum number of items per page. -Some methods, such as `list_keys` or `list_head`, paginate differently. Regardless, the primary results are always stored under the `items` field, and the `limit` field can be used to control the number of results returned. +Some methods, such as `list_keys` or `list_head`, paginate differently. Regardless, the primary results are always stored under the items property, and the limit property can be used to control the number of results returned. -The following example shows how to fetch all items from a dataset using pagination: +The following example demonstrates how to fetch all items from a dataset using pagination: @@ -42,42 +37,4 @@ The following example shows how to fetch all items from a dataset using paginati -The page model interface offers several key benefits. Its consistent structure ensures predictable results for most `list` methods, providing a uniform way to work with paginated data. It also offers flexibility, allowing you to customize the `limit` and `offset` parameters to control data fetching according to your needs. Additionally, it provides scalability, enabling you to efficiently handle large datasets through pagination. This approach ensures efficient data retrieval while keeping memory usage under control, making it ideal for managing and processing large collections. - -## Generator-based iteration - -For collection clients, the `iterate` method returns an iterator that lazily fetches as many pages as needed -to retrieve every item matching the filters. For dataset, key-value store and request queue clients, the -matching helpers are `iterate_items`, `iterate_keys` and `iterate_requests`. They handle pagination -automatically, so you don't need to manage offsets, limits or cursors yourself. - -The example below iterates over every Actor owned by the current user using a collection client's `iterate` -method: - - - - - {IterateCollectionAsyncExample} - - - - - {IterateCollectionSyncExample} - - - - -The next example uses `iterate_items` on a dataset client to stream items past a given offset: - - - - - {IterateItemsAsyncExample} - - - - - {IterateItemsSyncExample} - - - +The `ListPage` interface offers several key benefits. Its consistent structure ensures predictable results for most `list` methods, providing a uniform way to work with paginated data. It also offers flexibility, allowing you to customize the `limit` and `offset` parameters to control data fetching according to your needs. Additionally, it provides scalability, enabling you to efficiently handle large datasets through pagination. This approach ensures efficient data retrieval while keeping memory usage under control, making it ideal for managing and processing large collections. diff --git a/website/versioned_docs/version-2.5/02_concepts/09_streaming.mdx b/website/versioned_docs/version-2.5/02_concepts/09_streaming.mdx index 53ea1fcf..20ff30ec 100644 --- a/website/versioned_docs/version-2.5/02_concepts/09_streaming.mdx +++ b/website/versioned_docs/version-2.5/02_concepts/09_streaming.mdx @@ -1,7 +1,6 @@ --- id: streaming-resources title: Streaming resources -description: Stream large datasets, key-value store records, and logs without loading them into memory. --- import Tabs from '@theme/Tabs'; @@ -23,7 +22,7 @@ Supported streaming methods: These methods return a raw, context-managed `impit.Response` object. The response must be consumed within a with block to ensure that the connection is closed automatically, preventing memory leaks or unclosed connections. -The following example shows how to stream the logs of an Actor run incrementally: +The following example demonstrates how to stream the logs of an Actor run incrementally: @@ -38,4 +37,4 @@ The following example shows how to stream the logs of an Actor run incrementally -Streaming is ideal for processing large logs, datasets, or files incrementally without downloading them entirely into memory. +Streaming offers several key benefits. It ensures memory efficiency by loading only a small portion of the resource into memory at any given time, making it ideal for handling large data. It enables real-time processing, allowing you to start working with data immediately as it is received. With automatic resource management, using the `with` statement ensures that connections are properly closed, preventing memory leaks or unclosed connections. This approach is valuable for processing large logs, datasets, or files on the fly without the need to download them entirely. diff --git a/website/versioned_docs/version-2.5/02_concepts/code/03_nested_async.py b/website/versioned_docs/version-2.5/02_concepts/code/03_nested_async.py index f1d4c27f..662657c8 100644 --- a/website/versioned_docs/version-2.5/02_concepts/code/03_nested_async.py +++ b/website/versioned_docs/version-2.5/02_concepts/code/03_nested_async.py @@ -9,11 +9,11 @@ async def main() -> None: actor_client = apify_client.actor('username/actor-name') runs_client = actor_client.runs() - # List the last 10 runs of the Actor. + # List the last 10 runs of the Actor actor_runs = (await runs_client.list(limit=10, desc=True)).items - # Select the last run of the Actor that finished with a SUCCEEDED status. - last_succeeded_run_client = actor_client.last_run(status='SUCCEEDED') + # Select the last run of the Actor that finished with a SUCCEEDED status + last_succeeded_run_client = actor_client.last_run(status='SUCCEEDED') # ty: ignore[invalid-argument-type] # Get dataset actor_run_dataset_client = last_succeeded_run_client.dataset() diff --git a/website/versioned_docs/version-2.5/02_concepts/code/03_nested_sync.py b/website/versioned_docs/version-2.5/02_concepts/code/03_nested_sync.py index 65ae8dd2..74654576 100644 --- a/website/versioned_docs/version-2.5/02_concepts/code/03_nested_sync.py +++ b/website/versioned_docs/version-2.5/02_concepts/code/03_nested_sync.py @@ -9,11 +9,11 @@ def main() -> None: actor_client = apify_client.actor('username/actor-name') runs_client = actor_client.runs() - # List the last 10 runs of the Actor. + # List the last 10 runs of the Actor actor_runs = runs_client.list(limit=10, desc=True).items - # Select the last run of the Actor that finished with a SUCCEEDED status. - last_succeeded_run_client = actor_client.last_run(status='SUCCEEDED') + # Select the last run of the Actor that finished with a SUCCEEDED status + last_succeeded_run_client = actor_client.last_run(status='SUCCEEDED') # ty: ignore[invalid-argument-type] # Get dataset actor_run_dataset_client = last_succeeded_run_client.dataset() diff --git a/website/versioned_docs/version-2.5/02_concepts/code/04_error_async.py b/website/versioned_docs/version-2.5/02_concepts/code/04_error_async.py index 967ed2eb..0057ea44 100644 --- a/website/versioned_docs/version-2.5/02_concepts/code/04_error_async.py +++ b/website/versioned_docs/version-2.5/02_concepts/code/04_error_async.py @@ -1,7 +1,4 @@ -import asyncio - from apify_client import ApifyClientAsync -from apify_client.errors import ApifyApiError, NotFoundError TOKEN = 'MY-APIFY-TOKEN' @@ -10,19 +7,9 @@ async def main() -> None: apify_client = ApifyClientAsync(TOKEN) try: - # Try to list items from a non-existing dataset. - dataset_client = apify_client.dataset('non-existing-dataset-id') + # Try to list items from non-existing dataset + dataset_client = apify_client.dataset('not-existing-dataset-id') dataset_items = (await dataset_client.list_items()).items - except NotFoundError: - # 404 — branch on a specific subclass when you want to react to it. - dataset_items = [] - except ApifyApiError as err: - # Catch-all for every other API error. - print(f'API error: {err}') - dataset_items = [] - - print(f'Fetched {len(dataset_items)} items.') - - -if __name__ == '__main__': - asyncio.run(main()) + except Exception as ApifyApiError: + # The exception is an instance of ApifyApiError + print(ApifyApiError) diff --git a/website/versioned_docs/version-2.5/02_concepts/code/04_error_sync.py b/website/versioned_docs/version-2.5/02_concepts/code/04_error_sync.py index 7d100ba9..83fc3080 100644 --- a/website/versioned_docs/version-2.5/02_concepts/code/04_error_sync.py +++ b/website/versioned_docs/version-2.5/02_concepts/code/04_error_sync.py @@ -1,5 +1,4 @@ from apify_client import ApifyClient -from apify_client.errors import ApifyApiError, NotFoundError TOKEN = 'MY-APIFY-TOKEN' @@ -8,19 +7,9 @@ def main() -> None: apify_client = ApifyClient(TOKEN) try: - # Try to list items from a non-existing dataset. - dataset_client = apify_client.dataset('non-existing-dataset-id') + # Try to list items from non-existing dataset + dataset_client = apify_client.dataset('not-existing-dataset-id') dataset_items = dataset_client.list_items().items - except NotFoundError: - # 404 — branch on a specific subclass when you want to react to it. - dataset_items = [] - except ApifyApiError as err: - # Catch-all for every other API error. - print(f'API error: {err}') - dataset_items = [] - - print(f'Fetched {len(dataset_items)} items.') - - -if __name__ == '__main__': - main() + except Exception as ApifyApiError: + # The exception is an instance of ApifyApiError + print(ApifyApiError) diff --git a/website/versioned_docs/version-2.5/02_concepts/code/07_call_async.py b/website/versioned_docs/version-2.5/02_concepts/code/07_call_async.py index 3fe5a56f..955f7532 100644 --- a/website/versioned_docs/version-2.5/02_concepts/code/07_call_async.py +++ b/website/versioned_docs/version-2.5/02_concepts/code/07_call_async.py @@ -7,8 +7,8 @@ async def main() -> None: apify_client = ApifyClientAsync(TOKEN) actor_client = apify_client.actor('username/actor-name') - # Start an Actor and wait for it to finish. + # Start an Actor and waits for it to finish finished_actor_run = await actor_client.call() - # Start an Actor and wait up to 60 seconds for it to finish. + # Starts an Actor and waits maximum 60s (1 minute) for the finish actor_run = await actor_client.start(wait_for_finish=60) diff --git a/website/versioned_docs/version-2.5/02_concepts/code/07_call_sync.py b/website/versioned_docs/version-2.5/02_concepts/code/07_call_sync.py index 366f32ef..af790eaa 100644 --- a/website/versioned_docs/version-2.5/02_concepts/code/07_call_sync.py +++ b/website/versioned_docs/version-2.5/02_concepts/code/07_call_sync.py @@ -7,8 +7,8 @@ def main() -> None: apify_client = ApifyClient(TOKEN) actor_client = apify_client.actor('username/actor-name') - # Start an Actor and wait for it to finish. + # Start an Actor and waits for it to finish finished_actor_run = actor_client.call() - # Start an Actor and wait up to 60 seconds for it to finish. + # Starts an Actor and waits maximum 60s (1 minute) for the finish actor_run = actor_client.start(wait_for_finish=60) diff --git a/website/versioned_docs/version-2.5/02_concepts/code/08_pagination_async.py b/website/versioned_docs/version-2.5/02_concepts/code/08_pagination_async.py index 23ac5fde..50e9d047 100644 --- a/website/versioned_docs/version-2.5/02_concepts/code/08_pagination_async.py +++ b/website/versioned_docs/version-2.5/02_concepts/code/08_pagination_async.py @@ -10,15 +10,26 @@ async def main() -> None: dataset_client = apify_client.dataset('dataset-id') # Define the pagination parameters - limit = 1000 # Number items to request from API + limit = 1000 # Number of items per page offset = 0 # Starting offset + all_items = [] # List to store all fetched items - # Send single API call to fetch paginated items. - # (number of items per single call can be limited by API) - paginated_items = await dataset_client.list_items(limit=limit, offset=offset) + while True: + # Fetch a page of items + response = await dataset_client.list_items(limit=limit, offset=offset) + items = response.items + total = response.total - # Inspect pagination metadata returned by API - print(paginated_items.total) + print(f'Fetched {len(items)} items') - for item in paginated_items.items: - print(item) # Process the item as needed + # Add the fetched items to the complete list + all_items.extend(items) + + # Exit the loop if there are no more items to fetch + if offset + limit >= total: + break + + # Increment the offset for the next page + offset += limit + + print(f'Overall fetched {len(all_items)} items') diff --git a/website/versioned_docs/version-2.5/02_concepts/code/08_pagination_sync.py b/website/versioned_docs/version-2.5/02_concepts/code/08_pagination_sync.py index f144339e..3beb4fbe 100644 --- a/website/versioned_docs/version-2.5/02_concepts/code/08_pagination_sync.py +++ b/website/versioned_docs/version-2.5/02_concepts/code/08_pagination_sync.py @@ -10,15 +10,26 @@ def main() -> None: dataset_client = apify_client.dataset('dataset-id') # Define the pagination parameters - limit = 1000 # Number items to request from API + limit = 1000 # Number of items per page offset = 0 # Starting offset + all_items = [] # List to store all fetched items - # Send single API call to fetch paginated items. - # (number of items per single call can be limited by API) - paginated_items = dataset_client.list_items(limit=limit, offset=offset) + while True: + # Fetch a page of items + response = dataset_client.list_items(limit=limit, offset=offset) + items = response.items + total = response.total - # Inspect pagination metadata returned by API - print(paginated_items.total) + print(f'Fetched {len(items)} items') - for item in paginated_items.items: - print(item) # Process the item as needed + # Add the fetched items to the complete list + all_items.extend(items) + + # Exit the loop if there are no more items to fetch + if offset + limit >= total: + break + + # Increment the offset for the next page + offset += limit + + print(f'Overall fetched {len(all_items)} items') diff --git a/website/versioned_docs/version-2.5/03_guides/01_passing_input_to_actor.mdx b/website/versioned_docs/version-2.5/03_guides/01_passing_input_to_actor.mdx index 5ac6b91c..61769d73 100644 --- a/website/versioned_docs/version-2.5/03_guides/01_passing_input_to_actor.mdx +++ b/website/versioned_docs/version-2.5/03_guides/01_passing_input_to_actor.mdx @@ -1,7 +1,6 @@ --- id: passing-input-to-actor -title: Pass input to an Actor -description: Run an Actor with custom input data and retrieve results. +title: Passing input to Actor --- import Tabs from '@theme/Tabs'; @@ -11,9 +10,9 @@ import CodeBlock from '@theme/CodeBlock'; import StreamingAsyncExample from '!!raw-loader!./code/01_input_async.py'; import StreamingSyncExample from '!!raw-loader!./code/01_input_sync.py'; -You can pass input data directly to the `call` method to configure and run an Actor in a single step. +The efficient way to run an Actor and retrieve results is by passing input data directly to the `call` method. This method allows you to configure the Actor's input, execute it, and either get a reference to the running Actor or wait for its completion. -The following example shows how to pass input to the `apify/instagram-hashtag-scraper` Actor and wait for it to finish. +The following example demonstrates how to pass input to the `apify/instagram-hashtag-scraper` Actor and wait for it to finish. diff --git a/website/versioned_docs/version-2.5/03_guides/02_manage_tasks_for_reusable_input.mdx b/website/versioned_docs/version-2.5/03_guides/02_manage_tasks_for_reusable_input.mdx index 205c77c5..9865e232 100644 --- a/website/versioned_docs/version-2.5/03_guides/02_manage_tasks_for_reusable_input.mdx +++ b/website/versioned_docs/version-2.5/03_guides/02_manage_tasks_for_reusable_input.mdx @@ -1,7 +1,6 @@ --- id: manage-tasks-for-reusable-input title: Manage tasks for reusable input -description: Create and manage tasks with reusable input configurations. --- import Tabs from '@theme/Tabs'; @@ -13,7 +12,7 @@ import TasksSyncExample from '!!raw-loader!./code/02_tasks_sync.py'; When you need to run multiple inputs with the same Actor, the most convenient approach is to create multiple [tasks](https://docs.apify.com/platform/actors/running/tasks), each with different input configurations. Task inputs are stored on the Apify platform when the task is created, allowing you to reuse them easily. -The following example shows how to create tasks for the `apify/instagram-hashtag-scraper` Actor with different inputs, manage task clients, and execute them asynchronously: +The following example demonstrates how to create tasks for the `apify/instagram-hashtag-scraper` Actor with different inputs, manage task clients, and execute them asynchronously: diff --git a/website/versioned_docs/version-2.5/03_guides/03_retrieve_actor_data.mdx b/website/versioned_docs/version-2.5/03_guides/03_retrieve_actor_data.mdx index 7490f114..f139b2a9 100644 --- a/website/versioned_docs/version-2.5/03_guides/03_retrieve_actor_data.mdx +++ b/website/versioned_docs/version-2.5/03_guides/03_retrieve_actor_data.mdx @@ -1,7 +1,6 @@ --- id: retrieve-actor-data title: Retrieve Actor data -description: Fetch, paginate, and merge datasets from Actor runs. --- import Tabs from '@theme/Tabs'; @@ -13,7 +12,7 @@ import RetrieveSyncExample from '!!raw-loader!./code/03_retrieve_sync.py'; Actor output data is stored in [datasets](https://docs.apify.com/platform/storage/dataset), which can be retrieved from individual Actor runs. Dataset items support pagination for efficient retrieval, and multiple datasets can be merged into a single dataset for further analysis. This merged dataset can then be exported into various formats such as CSV, JSON, XLSX, or XML. Additionally, [integrations](https://docs.apify.com/platform/integrations) provide powerful tools to automate data workflows. -The following example shows how to fetch datasets from an Actor's runs, paginate through their items, and merge them into a single dataset for unified analysis: +The following example demonstrates how to fetch datasets from an Actor's runs, paginate through their items, and merge them into a single dataset for unified analysis: diff --git a/website/versioned_docs/version-2.5/03_guides/04_integration_with_data_libraries.mdx b/website/versioned_docs/version-2.5/03_guides/04_integration_with_data_libraries.mdx index ab5dc4f7..9c4cad3e 100644 --- a/website/versioned_docs/version-2.5/03_guides/04_integration_with_data_libraries.mdx +++ b/website/versioned_docs/version-2.5/03_guides/04_integration_with_data_libraries.mdx @@ -1,7 +1,6 @@ --- id: integration-with-data-libraries -title: Integrate with data libraries -description: Load Apify dataset items into Pandas DataFrames for analysis. +title: Integration with data libraries --- import Tabs from '@theme/Tabs'; @@ -13,7 +12,7 @@ import PandasSyncExample from '!!raw-loader!./code/04_pandas_sync.py'; The Apify client for Python seamlessly integrates with data analysis libraries like [Pandas](https://pandas.pydata.org/). This allows you to load dataset items directly into a Pandas [DataFrame](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html) for efficient manipulation and analysis. Pandas provides robust data structures and tools for handling large datasets, making it a powerful addition to your Apify workflows. -The following example shows how to retrieve items from the most recent dataset of an Actor run and load them into a Pandas DataFrame for further analysis: +The following example demonstrates how to retrieve items from the most recent dataset of an Actor run and load them into a Pandas DataFrame for further analysis: diff --git a/website/versioned_docs/version-2.5/04_upgrading/upgrading_to_v2.mdx b/website/versioned_docs/version-2.5/04_upgrading/upgrading_to_v2.mdx index ed02202b..6631c716 100644 --- a/website/versioned_docs/version-2.5/04_upgrading/upgrading_to_v2.mdx +++ b/website/versioned_docs/version-2.5/04_upgrading/upgrading_to_v2.mdx @@ -43,4 +43,4 @@ Some modules have been restructured. ### Errors -- Error classes are now accessible from the public `apify_client.errors` module. See the `ApifyApiError` API reference for a complete list of available error classes. +- Error classes are now accessible from the public `apify_client.errors` module. See the [API documentation](https://docs.apify.com/api/client/python/reference/class/ApifyApiError) for a complete list of available error classes. diff --git a/website/versioned_docs/version-2.5/api-packages.json b/website/versioned_docs/version-2.5/api-packages.json index 2730ed49..61a377ca 100644 --- a/website/versioned_docs/version-2.5/api-packages.json +++ b/website/versioned_docs/version-2.5/api-packages.json @@ -1 +1,10 @@ -[{"entryPoints":{"index":{"label":"Index","path":"src/index.ts"}},"packageRoot":".","packagePath":".","packageSlug":".","packageName":"apify-client-python-website"}] \ No newline at end of file +[ + { + "entryPoints": { "index": { "label": "Index", "path": "src/apify_client" } }, + "packageRoot": "..", + "packagePath": ".", + "packageSlug": ".", + "packageName": "apify-client", + "packageVersion": "2.5.0" + } +] diff --git a/website/versioned_docs/version-2.5/api-typedoc.json b/website/versioned_docs/version-2.5/api-typedoc.json index 5e0d87a7..4d34cfd8 100644 --- a/website/versioned_docs/version-2.5/api-typedoc.json +++ b/website/versioned_docs/version-2.5/api-typedoc.json @@ -1,170458 +1,37978 @@ { + "id": 0, + "name": "apify-client", + "kind": 1, + "kindString": "Project", + "flags": {}, + "originalName": "", "children": [ { + "id": 1, + "name": "ApifyClientError", + "module": "apify_client.errors", "kind": 128, "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Total number of API method calls made by the client." - } - ] - }, - "flags": {}, - "groups": [], - "id": 2, - "module": "_statistics", - "name": "calls", - "parsedDocstring": { - "text": "Total number of API method calls made by the client." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_statistics.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 11 - } - ], - "type": { - "name": "int", - "type": "reference" + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for errors specific to the Apify API Client." } - }, + ] + }, + "children": [], + "groups": [], + "sources": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Total number of HTTP requests sent, including retries." - } - ] - }, - "flags": {}, - "groups": [], - "id": 3, - "module": "_statistics", - "name": "requests", - "parsedDocstring": { - "text": "Total number of HTTP requests sent, including retries." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_statistics.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 14 - } - ], - "type": { - "name": "int", - "type": "reference" + "filename": "/src/apify_client/errors.py", + "line": 9, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/errors.py#L9" + } + ] + }, + { + "id": 2, + "name": "ApifyApiError", + "module": "apify_client.errors", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error specific to requests to the Apify API.\n\nAn `ApifyApiError` is thrown for successful HTTP requests that reach the API, but the API responds with\nan error response. Typically, those are rate limit errors and internal errors, which are automatically retried,\nor validation errors, which are thrown immediately, because a correction by the user is needed." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List tracking which retry attempts encountered rate limit (429) errors." - } - ] - }, + "id": 3, + "name": "__init__", + "module": "apify_client.errors", + "kind": 512, + "kindString": "Constructor", "flags": {}, - "groups": [], - "id": 4, - "module": "_statistics", - "name": "rate_limit_errors", - "parsedDocstring": { - "text": "List tracking which retry attempts encountered rate limit (429) errors." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_statistics.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 17 - } - ], - "type": { - "name": "defaultdict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "reference", - "name": "int" - } - ] - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Add rate limit error for specific attempt.\n" + "text": "Initialize a new instance.\n\nArgs:\n response: The response to the failed API call.\n attempt: Which attempt was the request that failed.\n method: The HTTP method used for the request." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 5, - "module": "_statistics", - "name": "add_rate_limit_error", - "parsedDocstring": { - "text": "Add rate limit error for specific attempt.\n", - "args": { - "attempt": "The attempt number (1-based indexing)." - } - }, "sources": [ { + "filename": "/src/apify_client/errors.py", + "line": 21, "character": 1, - "fileName": "/src/apify_client/_statistics.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 20 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/errors.py#L21" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 4, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Add rate limit error for specific attempt.\n" + "text": "Initialize a new instance.\n\n" } ] }, - "flags": {}, - "id": 6, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "add_rate_limit_error", + "type": { + "type": "reference", + "name": "None" + }, "parameters": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attempt number (1-based indexing)." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 7, + "id": 5, + "name": "response", "kind": 32768, "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "impit.Response" + } + }, + { + "id": 6, "name": "attempt", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, "type": { - "name": "int", - "type": "reference" + "type": "intrinsic", + "name": "int" } + }, + { + "id": 7, + "name": "method", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + }, + "defaultValue": "'GET'" } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } + ] } ] } ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statistics about API client usage and rate limit errors." - } - ] - }, - "decorations": [ - { - "name": "dataclass" - } - ], - "flags": {}, "groups": [ { + "title": "Constructors", "children": [ - 5 - ], - "title": "Methods" - }, - { - "children": [ - 2, - 4, 3 - ], - "title": "Properties" + ] } ], - "id": 1, - "module": "_statistics", - "name": "ClientStatistics", - "parsedDocstring": { - "text": "Statistics about API client usage and rate limit errors." - }, "sources": [ { + "filename": "/src/apify_client/errors.py", + "line": 13, "character": 1, - "fileName": "/src/apify_client/_statistics.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 8 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/errors.py#L13" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], "id": 8, - "module": "_docs", - "name": "GroupName", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_docs.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 8 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, + "name": "InvalidResponseBodyError", + "module": "apify_client.errors", + "kind": 128, + "kindString": "Class", "flags": {}, - "groups": [], - "id": 9, - "module": "_docs", - "name": "T", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_docs.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 18 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "Mark a symbol for rendering and grouping in documentation.\n\nThis decorator is used solely for documentation purposes and does not modify the behavior\nof the decorated callable.\n" + "text": "Error caused by the response body failing to be parsed.\n\nThis error exists for the quite common situation, where only a partial JSON response is received and an attempt\nto parse the JSON throws an error. In most cases this can be resolved by retrying the request. We do that by\nidentifying this error in the HTTPClient." } ] }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 10, - "module": "_docs", - "name": "docs_group", - "parsedDocstring": { - "text": "Mark a symbol for rendering and grouping in documentation.\n\nThis decorator is used solely for documentation purposes and does not modify the behavior\nof the decorated callable.\n", - "args": { - "group_name": "The documentation group to which the symbol belongs.\n" - }, - "returns": "The original callable without modification." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_docs.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 21 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ + "children": [ { + "id": 9, + "name": "__init__", + "module": "apify_client.errors", + "kind": 512, + "kindString": "Constructor", + "flags": {}, "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The original callable without modification." - } - ], - "tag": "@returns" - } - ], "summary": [ { "kind": "text", - "text": "Mark a symbol for rendering and grouping in documentation.\n\nThis decorator is used solely for documentation purposes and does not modify the behavior\nof the decorated callable.\n" + "text": "Initialize a new instance.\n\nArgs:\n response: The response which failed to be parsed." } ] }, - "flags": {}, - "id": 11, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "docs_group", - "parameters": [ + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/errors.py", + "line": 65, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/errors.py#L65" + } + ], + "signatures": [ { + "id": 10, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The documentation group to which the symbol belongs.\n" + "text": "Initialize a new instance.\n\n" } ] }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 12, - "kind": 32768, - "kindString": "Parameter", - "name": "group_name", "type": { - "name": "GroupName", - "type": "reference", - "target": "8" - } - } - ], - "type": { - "name": "Callable", - "type": "reference", - "typeArguments": [ - { "type": "reference", - "name": "[T]" + "name": "None" }, - { - "type": "reference", - "name": "T", - "target": "9" - } - ] - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type for the `timeout` parameter on resource client methods.\n\n`'short'`, `'medium'`, and `'long'` are tier literals resolved by the HTTP client to configured values.\nA `timedelta` overrides the timeout for this call, and `'no_timeout'` disables the timeout entirely." - } - ] - }, - "flags": {}, - "groups": [], - "id": 13, - "module": "types", - "name": "Timeout", - "parsedDocstring": { - "text": "Type for the `timeout` parameter on resource client methods.\n\n`'short'`, `'medium'`, and `'long'` are tier literals resolved by the HTTP client to configured values.\nA `timedelta` overrides the timeout for this call, and `'no_timeout'` disables the timeout entirely." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/types.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 14 + "parameters": [ + { + "id": 11, + "name": "response", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "impit.Response" + } + } + ] + } + ] } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type for the `webhooks` parameter on resource-client `start`/`call` methods and `from_webhooks`.\n\n`WebhookRepresentation` / `WebhookRepresentationDict` / `WebhookRepresentationCamelDict` are the minimal ad-hoc\nwebhook shape (only `event_types` and `request_url` required). `WebhookCreate` / `WebhookCreateDict` /\n`WebhookCreateCamelDict` are accepted so a persistent-webhook definition can be reused; their fields not relevant\nto ad-hoc webhooks (e.g. `condition`) are ignored at runtime. The `*CamelDict` variants accept camelCase keys\nmatching the Apify API spelling." - } - ] - }, - "flags": {}, - "groups": [], - "id": 14, - "module": "types", - "name": "WebhooksList", - "parsedDocstring": { - "text": "Type for the `webhooks` parameter on resource-client `start`/`call` methods and `from_webhooks`.\n\n`WebhookRepresentation` / `WebhookRepresentationDict` / `WebhookRepresentationCamelDict` are the minimal ad-hoc\nwebhook shape (only `event_types` and `request_url` required). `WebhookCreate` / `WebhookCreateDict` /\n`WebhookCreateCamelDict` are accepted so a persistent-webhook definition can be reused; their fields not relevant\nto ad-hoc webhooks (e.g. `condition`) are ignored at runtime. The `*CamelDict` variants accept camelCase keys\nmatching the Apify API spelling." - }, - "sources": [ + "groups": [ { - "character": 1, - "fileName": "/src/apify_client/types.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 21 + "title": "Constructors", + "children": [ + 9 + ] } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Recursive type for JSON-serializable values - primitives plus objects and arrays with JSON-serializable contents.\n\nBased on the definition discussed in https://github.com/python/typing/issues/182." - } - ] - }, - "flags": {}, - "groups": [], - "id": 15, - "module": "types", - "name": "JsonSerializable", - "parsedDocstring": { - "text": "Recursive type for JSON-serializable values - primitives plus objects and arrays with JSON-serializable contents.\n\nBased on the definition discussed in https://github.com/python/typing/issues/182." - }, "sources": [ { + "filename": "/src/apify_client/errors.py", + "line": 57, "character": 1, - "fileName": "/src/apify_client/types.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 38 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/errors.py#L57" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 12, + "name": "WebhookDispatchCollectionClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Base class for all Apify API client errors." + "text": "Sub-client for listing webhook dispatches." } ] }, - "decorations": [ - { - "args": "('Errors')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [], - "id": 16, - "module": "errors", - "name": "ApifyClientError", - "parsedDocstring": { - "text": "Base class for all Apify API client errors." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 15 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "ApifyApiError", - "target": "17", - "type": "reference" - }, - { - "name": "InvalidResponseBodyError", - "target": "35", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", "children": [ { + "id": 13, + "name": "list", + "module": "apify_client.clients.resource_clients.webhook_dispatch_collection", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n\nArgs:\n limit: How many webhook dispatches to retrieve.\n offset: What webhook dispatch to include as first when retrieving the list.\n desc: Whether to sort the webhook dispatches in descending order based on the date of their creation.\n\nReturns:\n The retrieved webhook dispatches of a user." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 18, - "module": "errors", - "name": "__new__", - "parsedDocstring": { - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py", + "line": 18, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 42 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py#L18" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 14, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n\n" } ] }, - "flags": {}, - "id": 19, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__new__", + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, "parameters": [ { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 20, + "id": 15, + "name": "limit", "kind": 32768, "kindString": "Parameter", - "name": "response", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "HttpResponse", "type": "reference", - "target": "1805" - } + "name": "int | None" + }, + "defaultValue": "None" }, { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 21, + "id": 16, + "name": "offset", "kind": 32768, "kindString": "Parameter", - "name": "attempt", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "int", - "type": "reference" - } + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" }, { - "defaultValue": "'GET'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 22, + "id": 17, + "name": "desc", "kind": 32768, "kindString": "Parameter", - "name": "method", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "str", - "type": "reference" - } + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" } - ], - "type": { - "name": "Self", - "type": "reference" - } + ] } ] - }, + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 13 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py", + "line": 11, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py#L11" + } + ] + }, + { + "id": 18, + "name": "WebhookDispatchCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for listing webhook dispatches." + } + ] + }, + "children": [ { + "id": 19, + "name": "list", + "module": "apify_client.clients.resource_clients.webhook_dispatch_collection", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize the API error from a failed response.\n" + "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n\nArgs:\n limit: How many webhook dispatches to retrieve.\n offset: What webhook dispatch to include as first when retrieving the list.\n desc: Whether to sort the webhook dispatches in descending order based on the date of their creation.\n\nReturns:\n The retrieved webhook dispatches of a user." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 23, - "module": "errors", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the API error from a failed response.\n", - "args": { - "response": "The failed HTTP response from the Apify API.", - "attempt": "The attempt number when the request failed (1-indexed).", - "method": "The HTTP method of the failed request." - } - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py", + "line": 47, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 54 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py#L47" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 20, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize the API error from a failed response.\n" + "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n\n" } ] }, - "flags": {}, - "id": 24, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, "parameters": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The failed HTTP response from the Apify API." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 25, + "id": 21, + "name": "limit", "kind": 32768, "kindString": "Parameter", - "name": "response", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "HttpResponse", "type": "reference", - "target": "1805" - } + "name": "int | None" + }, + "defaultValue": "None" }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attempt number when the request failed (1-indexed)." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 26, + "id": 22, + "name": "offset", "kind": 32768, "kindString": "Parameter", - "name": "attempt", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "int", - "type": "reference" - } + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP method of the failed request." - } - ] - }, - "defaultValue": "'GET'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 27, + "id": 23, + "name": "desc", "kind": 32768, "kindString": "Parameter", - "name": "method", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "str", - "type": "reference" - } + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } + ] } ] } ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error raised when the Apify API returns an error response.\n\nInstantiating `ApifyApiError` dispatches to the subclass matching the HTTP status code (e.g. 404 → `NotFoundError`,\nany 5xx → `ServerError`). Unmapped statuses stay on `ApifyApiError`. Existing `except ApifyApiError` handlers keep\nworking because every subclass inherits from this class.\n\nThe `type`, `message` and `data` fields from the response body are exposed for inspection but are treated as\nnon-authoritative metadata — dispatch is driven by the status code only.\n" - } - ] - }, - "decorations": [ - { - "args": "('Errors')", - "name": "docs_group" - } - ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 23, - 18 - ], - "title": "Methods" + 19 + ] } ], - "id": 17, - "module": "errors", - "name": "ApifyApiError", - "parsedDocstring": { - "text": "Error raised when the Apify API returns an error response.\n\nInstantiating `ApifyApiError` dispatches to the subclass matching the HTTP status code (e.g. 404 → `NotFoundError`,\nany 5xx → `ServerError`). Unmapped statuses stay on `ApifyApiError`. Existing `except ApifyApiError` handlers keep\nworking because every subclass inherits from this class.\n\nThe `type`, `message` and `data` fields from the response body are exposed for inspection but are treated as\nnon-authoritative metadata — dispatch is driven by the status code only.\n" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py", + "line": 40, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 20 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ApifyClientError", - "target": "16", - "type": "reference" - } - ], - "extendedBy": [ - { - "name": "InvalidRequestError", - "target": "28", - "type": "reference" - }, - { - "name": "UnauthorizedError", - "target": "29", - "type": "reference" - }, - { - "name": "ForbiddenError", - "target": "30", - "type": "reference" - }, - { - "name": "NotFoundError", - "target": "31", - "type": "reference" - }, - { - "name": "ConflictError", - "target": "32", - "type": "reference" - }, - { - "name": "RateLimitError", - "target": "33", - "type": "reference" - }, - { - "name": "ServerError", - "target": "34", - "type": "reference" + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py#L40" } ] }, { + "id": 24, + "name": "WebhookDispatchClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for querying information about a webhook dispatch." + } + ] + }, "children": [ { + "id": 25, + "name": "get", + "module": "apify_client.clients.resource_clients.webhook_dispatch", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n\nReturns:\n The retrieved webhook dispatch, or None if it does not exist." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 4167, - "module": "errors", - "name": "__new__", - "parsedDocstring": { - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook_dispatch.py", + "line": 15, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 42 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_dispatch.py#L15" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 26, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n\n" } ] }, - "flags": {}, - "id": 19, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__new__", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 20, - "kind": 32768, - "kindString": "Parameter", - "name": "response", - "type": { - "name": "HttpResponse", - "type": "reference", - "target": "1805" - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 21, - "kind": 32768, - "kindString": "Parameter", - "name": "attempt", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "defaultValue": "'GET'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 22, - "kind": 32768, - "kindString": "Parameter", - "name": "method", - "type": { - "name": "str", - "type": "reference" - } - } - ], "type": { - "name": "Self", - "type": "reference" + "type": "reference", + "name": "dict | None" }, - "inheritedFrom": { - "name": "ApifyApiError.__new__", - "target": 18, - "type": "reference" - } + "parameters": [] } - ], - "inheritedFrom": { - "name": "ApifyApiError.__new__", - "target": 18, - "type": "reference" + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 25 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook_dispatch.py", + "line": 8, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_dispatch.py#L8" + } + ] + }, + { + "id": 27, + "name": "WebhookDispatchClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for querying information about a webhook dispatch." } - }, + ] + }, + "children": [ { + "id": 28, + "name": "get", + "module": "apify_client.clients.resource_clients.webhook_dispatch", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize the API error from a failed response.\n" + "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n\nReturns:\n The retrieved webhook dispatch, or None if it does not exist." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 4168, - "module": "errors", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the API error from a failed response.\n", - "args": { - "response": "The failed HTTP response from the Apify API.", - "attempt": "The attempt number when the request failed (1-indexed).", - "method": "The HTTP method of the failed request." - } - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook_dispatch.py", + "line": 33, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 54 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_dispatch.py#L33" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 29, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize the API error from a failed response.\n" + "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n\n" } ] }, - "flags": {}, - "id": 24, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The failed HTTP response from the Apify API." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 25, - "kind": 32768, - "kindString": "Parameter", - "name": "response", - "type": { - "name": "HttpResponse", - "type": "reference", - "target": "1805" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attempt number when the request failed (1-indexed)." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 26, - "kind": 32768, - "kindString": "Parameter", - "name": "attempt", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP method of the failed request." - } - ] - }, - "defaultValue": "'GET'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 27, - "kind": 32768, - "kindString": "Parameter", - "name": "method", - "type": { - "name": "str", - "type": "reference" - } - } - ], "type": { - "name": "None", - "type": "reference" + "type": "reference", + "name": "dict | None" }, - "inheritedFrom": { - "name": "ApifyApiError.__init__", - "target": 23, - "type": "reference" - } + "parameters": [] } - ], - "inheritedFrom": { - "name": "ApifyApiError.__init__", - "target": 23, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Raised when the Apify API returns an HTTP 400 Bad Request response." - } - ] - }, - "decorations": [ - { - "args": "('Errors')", - "name": "docs_group" + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 4168, - 4167 - ], - "title": "Methods" + 28 + ] } ], - "id": 28, - "module": "errors", - "name": "InvalidRequestError", - "parsedDocstring": { - "text": "Raised when the Apify API returns an HTTP 400 Bad Request response." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook_dispatch.py", + "line": 26, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 94 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ApifyApiError", - "target": "17", - "type": "reference" + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_dispatch.py#L26" } ] }, { + "id": 30, + "name": "WebhookCollectionClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating webhooks." + } + ] + }, "children": [ { + "id": 31, + "name": "list", + "module": "apify_client.clients.resource_clients.webhook_collection", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n\nArgs:\n limit: How many webhooks to retrieve.\n offset: What webhook to include as first when retrieving the list.\n desc: Whether to sort the webhooks in descending order based on their date of creation.\n\nReturns:\n The list of available webhooks matching the specified filters." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 4169, - "module": "errors", - "name": "__new__", - "parsedDocstring": { - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook_collection.py", + "line": 22, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 42 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_collection.py#L22" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 32, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n\n" } ] }, - "flags": {}, - "id": 19, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__new__", + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, "parameters": [ { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 20, + "id": 33, + "name": "limit", "kind": 32768, "kindString": "Parameter", - "name": "response", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "HttpResponse", "type": "reference", - "target": "1805" - } + "name": "int | None" + }, + "defaultValue": "None" }, { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 21, + "id": 34, + "name": "offset", "kind": 32768, "kindString": "Parameter", - "name": "attempt", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "int", - "type": "reference" - } + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" }, { - "defaultValue": "'GET'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 22, + "id": 35, + "name": "desc", "kind": 32768, "kindString": "Parameter", - "name": "method", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "str", - "type": "reference" - } + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" } - ], - "type": { - "name": "Self", - "type": "reference" - }, - "inheritedFrom": { - "name": "ApifyApiError.__new__", - "target": 18, - "type": "reference" - } + ] } - ], - "inheritedFrom": { - "name": "ApifyApiError.__new__", - "target": 18, - "type": "reference" - } + ] }, { + "id": 36, + "name": "create", + "module": "apify_client.clients.resource_clients.webhook_collection", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize the API error from a failed response.\n" + "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n\nArgs:\n event_types: List of event types that should trigger the webhook. At least one is required.\n request_url: URL that will be invoked once the webhook is triggered.\n payload_template: Specification of the payload that will be sent to request_url.\n headers_template: Headers that will be sent to the request_url.\n actor_id: Id of the Actor whose runs should trigger the webhook.\n actor_task_id: Id of the Actor task whose runs should trigger the webhook.\n actor_run_id: Id of the Actor run which should trigger the webhook.\n ignore_ssl_errors: Whether the webhook should ignore SSL errors returned by request_url.\n do_not_retry: Whether the webhook should retry sending the payload to request_url upon failure.\n idempotency_key: A unique identifier of a webhook. You can use it to ensure that you won't create\n the same webhook multiple times.\n is_ad_hoc: Set to True if you want the webhook to be triggered only the first time the condition\n is fulfilled. Only applicable when actor_run_id is filled.\n\nReturns:\n The created webhook." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 4170, - "module": "errors", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the API error from a failed response.\n", - "args": { - "response": "The failed HTTP response from the Apify API.", - "attempt": "The attempt number when the request failed (1-indexed).", - "method": "The HTTP method of the failed request." - } - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook_collection.py", + "line": 43, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 54 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_collection.py#L43" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 37, + "name": "create", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize the API error from a failed response.\n" + "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n\n" } ] }, - "flags": {}, - "id": 24, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", + "type": { + "type": "intrinsic", + "name": "dict" + }, "parameters": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The failed HTTP response from the Apify API." - } - ] + "id": 38, + "name": "event_types", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, + "type": { + "type": "reference", + "name": "list[WebhookEventType]" + } + }, + { + "id": 39, + "name": "request_url", + "kind": 32768, + "kindString": "Parameter", "flags": { - "isOptional": false, - "keyword-only": false + "keyword-only": "true" }, - "id": 25, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 40, + "name": "payload_template", "kind": 32768, "kindString": "Parameter", - "name": "response", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "HttpResponse", "type": "reference", - "target": "1805" - } + "name": "str | None" + }, + "defaultValue": "None" }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attempt number when the request failed (1-indexed)." - } - ] + "id": 41, + "name": "headers_template", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" }, + "defaultValue": "None" + }, + { + "id": 42, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", "flags": { - "isOptional": false, - "keyword-only": false + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" }, - "id": 26, + "defaultValue": "None" + }, + { + "id": 43, + "name": "actor_task_id", "kind": 32768, "kindString": "Parameter", - "name": "attempt", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "int", - "type": "reference" - } + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP method of the failed request." - } - ] + "id": 44, + "name": "actor_run_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 45, + "name": "ignore_ssl_errors", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" }, - "defaultValue": "'GET'", + "defaultValue": "None" + }, + { + "id": 46, + "name": "do_not_retry", + "kind": 32768, + "kindString": "Parameter", "flags": { - "isOptional": true, - "keyword-only": true + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" }, - "id": 27, + "defaultValue": "None" + }, + { + "id": 47, + "name": "idempotency_key", "kind": 32768, "kindString": "Parameter", - "name": "method", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "str", - "type": "reference" - } + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 48, + "name": "is_ad_hoc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" } - ], - "type": { - "name": "None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ApifyApiError.__init__", - "target": 23, - "type": "reference" - } + ] } - ], - "inheritedFrom": { - "name": "ApifyApiError.__init__", - "target": 23, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Raised when the Apify API returns an HTTP 401 Unauthorized response." - } - ] - }, - "decorations": [ - { - "args": "('Errors')", - "name": "docs_group" + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 4170, - 4169 - ], - "title": "Methods" + 36, + 31 + ] } ], - "id": 29, - "module": "errors", - "name": "UnauthorizedError", - "parsedDocstring": { - "text": "Raised when the Apify API returns an HTTP 401 Unauthorized response." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook_collection.py", + "line": 15, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 99 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ApifyApiError", - "target": "17", - "type": "reference" + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_collection.py#L15" } ] }, { + "id": 49, + "name": "WebhookCollectionClientAsync", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating webhooks." + } + ] + }, "children": [ { + "id": 50, + "name": "list", + "module": "apify_client.clients.resource_clients.webhook_collection", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n\nArgs:\n limit: How many webhooks to retrieve.\n offset: What webhook to include as first when retrieving the list.\n desc: Whether to sort the webhooks in descending order based on their date of creation.\n\nReturns:\n The list of available webhooks matching the specified filters." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 4171, - "module": "errors", - "name": "__new__", - "parsedDocstring": { - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook_collection.py", + "line": 106, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 42 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_collection.py#L106" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 51, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n\n" } ] }, - "flags": {}, - "id": 19, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__new__", + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, "parameters": [ { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 20, + "id": 52, + "name": "limit", "kind": 32768, "kindString": "Parameter", - "name": "response", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "HttpResponse", "type": "reference", - "target": "1805" - } + "name": "int | None" + }, + "defaultValue": "None" }, { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 21, + "id": 53, + "name": "offset", "kind": 32768, "kindString": "Parameter", - "name": "attempt", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "int", - "type": "reference" - } + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" }, { - "defaultValue": "'GET'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 22, + "id": 54, + "name": "desc", "kind": 32768, "kindString": "Parameter", - "name": "method", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "str", - "type": "reference" - } + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" } - ], - "type": { - "name": "Self", - "type": "reference" - }, - "inheritedFrom": { - "name": "ApifyApiError.__new__", - "target": 18, - "type": "reference" - } + ] } - ], - "inheritedFrom": { - "name": "ApifyApiError.__new__", - "target": 18, - "type": "reference" - } + ] }, { + "id": 55, + "name": "create", + "module": "apify_client.clients.resource_clients.webhook_collection", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize the API error from a failed response.\n" + "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n\nArgs:\n event_types: List of event types that should trigger the webhook. At least one is required.\n request_url: URL that will be invoked once the webhook is triggered.\n payload_template: Specification of the payload that will be sent to request_url.\n headers_template: Headers that will be sent to the request_url.\n actor_id: Id of the Actor whose runs should trigger the webhook.\n actor_task_id: Id of the Actor task whose runs should trigger the webhook.\n actor_run_id: Id of the Actor run which should trigger the webhook.\n ignore_ssl_errors: Whether the webhook should ignore SSL errors returned by request_url.\n do_not_retry: Whether the webhook should retry sending the payload to request_url upon failure.\n idempotency_key: A unique identifier of a webhook. You can use it to ensure that you won't create\n the same webhook multiple times.\n is_ad_hoc: Set to True if you want the webhook to be triggered only the first time the condition\n is fulfilled. Only applicable when actor_run_id is filled.\n\nReturns:\n The created webhook." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 4172, - "module": "errors", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the API error from a failed response.\n", - "args": { - "response": "The failed HTTP response from the Apify API.", - "attempt": "The attempt number when the request failed (1-indexed).", - "method": "The HTTP method of the failed request." - } - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook_collection.py", + "line": 127, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 54 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_collection.py#L127" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 56, + "name": "create", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize the API error from a failed response.\n" + "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n\n" } ] }, - "flags": {}, - "id": 24, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", + "type": { + "type": "intrinsic", + "name": "dict" + }, "parameters": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The failed HTTP response from the Apify API." - } - ] + "id": 57, + "name": "event_types", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, + "type": { + "type": "reference", + "name": "list[WebhookEventType]" + } + }, + { + "id": 58, + "name": "request_url", + "kind": 32768, + "kindString": "Parameter", "flags": { - "isOptional": false, - "keyword-only": false + "keyword-only": "true" }, - "id": 25, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 59, + "name": "payload_template", "kind": 32768, "kindString": "Parameter", - "name": "response", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "HttpResponse", "type": "reference", - "target": "1805" - } + "name": "str | None" + }, + "defaultValue": "None" }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attempt number when the request failed (1-indexed)." - } - ] + "id": 60, + "name": "headers_template", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 61, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", "flags": { - "isOptional": false, - "keyword-only": false + "keyword-only": "true" }, - "id": 26, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 62, + "name": "actor_task_id", "kind": 32768, "kindString": "Parameter", - "name": "attempt", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "int", - "type": "reference" - } + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP method of the failed request." - } - ] + "id": 63, + "name": "actor_run_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - "defaultValue": "'GET'", + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 64, + "name": "ignore_ssl_errors", + "kind": 32768, + "kindString": "Parameter", "flags": { - "isOptional": true, - "keyword-only": true + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" }, - "id": 27, + "defaultValue": "None" + }, + { + "id": 65, + "name": "do_not_retry", "kind": 32768, "kindString": "Parameter", - "name": "method", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "str", - "type": "reference" - } + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 66, + "name": "idempotency_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 67, + "name": "is_ad_hoc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" } - ], - "type": { - "name": "None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ApifyApiError.__init__", - "target": 23, - "type": "reference" - } + ] } - ], - "inheritedFrom": { - "name": "ApifyApiError.__init__", - "target": 23, - "type": "reference" - } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 55, + 50 + ] } ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook_collection.py", + "line": 99, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook_collection.py#L99" + } + ] + }, + { + "id": 68, + "name": "get_webhook_representation", + "module": "apify_client.clients.resource_clients.webhook", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Raised when the Apify API returns an HTTP 403 Forbidden response." + "text": "Prepare webhook dictionary representation for clients." } ] }, - "decorations": [ - { - "args": "('Errors')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4172, - 4171 - ], - "title": "Methods" - } - ], - "id": 30, - "module": "errors", - "name": "ForbiddenError", - "parsedDocstring": { - "text": "Raised when the Apify API returns an HTTP 403 Forbidden response." - }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 23, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 104 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L23" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ + "signatures": [ { - "name": "ApifyApiError", - "target": "17", - "type": "reference" + "id": 69, + "name": "get_webhook_representation", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Prepare webhook dictionary representation for clients." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 70, + "name": "event_types", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[WebhookEventType] | None" + }, + "defaultValue": "None" + }, + { + "id": 71, + "name": "request_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 72, + "name": "payload_template", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 73, + "name": "headers_template", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 74, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 75, + "name": "actor_task_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 76, + "name": "actor_run_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 77, + "name": "ignore_ssl_errors", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 78, + "name": "do_not_retry", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 79, + "name": "idempotency_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 80, + "name": "is_ad_hoc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] } ] }, { + "id": 81, + "name": "WebhookClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single webhook." + } + ] + }, "children": [ { + "id": 82, + "name": "get", + "module": "apify_client.clients.resource_clients.webhook", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n\nReturns:\n The retrieved webhook, or None if it does not exist." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 4173, - "module": "errors", - "name": "__new__", - "parsedDocstring": { - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 69, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 42 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L69" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 83, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n\n" } ] }, - "flags": {}, - "id": 19, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__new__", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 20, - "kind": 32768, - "kindString": "Parameter", - "name": "response", - "type": { - "name": "HttpResponse", - "type": "reference", - "target": "1805" - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 21, - "kind": 32768, - "kindString": "Parameter", - "name": "attempt", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "defaultValue": "'GET'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 22, - "kind": 32768, - "kindString": "Parameter", - "name": "method", - "type": { - "name": "str", - "type": "reference" - } - } - ], "type": { - "name": "Self", - "type": "reference" + "type": "reference", + "name": "dict | None" }, - "inheritedFrom": { - "name": "ApifyApiError.__new__", - "target": 18, - "type": "reference" - } + "parameters": [] } - ], - "inheritedFrom": { - "name": "ApifyApiError.__new__", - "target": 18, - "type": "reference" - } + ] }, { + "id": 84, + "name": "update", + "module": "apify_client.clients.resource_clients.webhook", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize the API error from a failed response.\n" + "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n\nArgs:\n event_types: List of event types that should trigger the webhook. At least one is required.\n request_url: URL that will be invoked once the webhook is triggered.\n payload_template: Specification of the payload that will be sent to request_url.\n headers_template: Headers that will be sent to the request_url.\n actor_id: Id of the Actor whose runs should trigger the webhook.\n actor_task_id: Id of the Actor task whose runs should trigger the webhook.\n actor_run_id: Id of the Actor run which should trigger the webhook.\n ignore_ssl_errors: Whether the webhook should ignore SSL errors returned by request_url.\n do_not_retry: Whether the webhook should retry sending the payload to request_url upon failure.\n is_ad_hoc: Set to True if you want the webhook to be triggered only the first time the condition\n is fulfilled. Only applicable when actor_run_id is filled.\n\nReturns:\n The updated webhook." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 4174, - "module": "errors", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the API error from a failed response.\n", - "args": { - "response": "The failed HTTP response from the Apify API.", - "attempt": "The attempt number when the request failed (1-indexed).", - "method": "The HTTP method of the failed request." - } - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 79, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 54 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L79" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 85, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize the API error from a failed response.\n" + "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n\n" } ] }, - "flags": {}, - "id": 24, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", + "type": { + "type": "intrinsic", + "name": "dict" + }, "parameters": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The failed HTTP response from the Apify API." - } - ] + "id": 86, + "name": "event_types", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[WebhookEventType] | None" }, + "defaultValue": "None" + }, + { + "id": 87, + "name": "request_url", + "kind": 32768, + "kindString": "Parameter", "flags": { - "isOptional": false, - "keyword-only": false + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" }, - "id": 25, + "defaultValue": "None" + }, + { + "id": 88, + "name": "payload_template", "kind": 32768, "kindString": "Parameter", - "name": "response", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "HttpResponse", "type": "reference", - "target": "1805" - } + "name": "str | None" + }, + "defaultValue": "None" }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attempt number when the request failed (1-indexed)." - } - ] + "id": 89, + "name": "headers_template", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" }, + "defaultValue": "None" + }, + { + "id": 90, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", "flags": { - "isOptional": false, - "keyword-only": false + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" }, - "id": 26, + "defaultValue": "None" + }, + { + "id": 91, + "name": "actor_task_id", "kind": 32768, "kindString": "Parameter", - "name": "attempt", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "int", - "type": "reference" - } + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP method of the failed request." - } - ] + "id": 92, + "name": "actor_run_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 93, + "name": "ignore_ssl_errors", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - "defaultValue": "'GET'", + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 94, + "name": "do_not_retry", + "kind": 32768, + "kindString": "Parameter", "flags": { - "isOptional": true, - "keyword-only": true + "keyword-only": "true" }, - "id": 27, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 95, + "name": "is_ad_hoc", "kind": 32768, "kindString": "Parameter", - "name": "method", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "str", - "type": "reference" - } + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" } - ], - "type": { - "name": "None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ApifyApiError.__init__", - "target": 23, - "type": "reference" + ] + } + ] + }, + { + "id": 96, + "name": "delete", + "module": "apify_client.clients.resource_clients.webhook", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook" } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 128, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L128" } ], - "inheritedFrom": { - "name": "ApifyApiError.__init__", - "target": 23, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Raised when the Apify API returns an HTTP 404 Not Found response." - } - ] - }, - "decorations": [ - { - "args": "('Errors')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4174, - 4173 - ], - "title": "Methods" - } - ], - "id": 31, - "module": "errors", - "name": "NotFoundError", - "parsedDocstring": { - "text": "Raised when the Apify API returns an HTTP 404 Not Found response." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 109 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ApifyApiError", - "target": "17", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ + { + "id": 97, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, { + "id": 98, + "name": "test", + "module": "apify_client.clients.resource_clients.webhook", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n\nReturns:\n The webhook dispatch created by the test." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 4175, - "module": "errors", - "name": "__new__", - "parsedDocstring": { - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 135, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 42 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L135" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 99, + "name": "test", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n\n" } ] }, - "flags": {}, - "id": 19, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__new__", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 20, - "kind": 32768, - "kindString": "Parameter", - "name": "response", - "type": { - "name": "HttpResponse", - "type": "reference", - "target": "1805" - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 21, - "kind": 32768, - "kindString": "Parameter", - "name": "attempt", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "defaultValue": "'GET'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 22, - "kind": 32768, - "kindString": "Parameter", - "name": "method", - "type": { - "name": "str", - "type": "reference" - } - } - ], "type": { - "name": "Self", - "type": "reference" + "type": "reference", + "name": "dict | None" }, - "inheritedFrom": { - "name": "ApifyApiError.__new__", - "target": 18, - "type": "reference" - } + "parameters": [] } - ], - "inheritedFrom": { - "name": "ApifyApiError.__new__", - "target": 18, - "type": "reference" - } + ] }, { + "id": 100, + "name": "dispatches", + "module": "apify_client.clients.resource_clients.webhook", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize the API error from a failed response.\n" + "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n\nReturns:\n A client allowing access to dispatches of this webhook using its list method." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 4176, - "module": "errors", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the API error from a failed response.\n", - "args": { - "response": "The failed HTTP response from the Apify API.", - "attempt": "The attempt number when the request failed (1-indexed).", - "method": "The HTTP method of the failed request." - } - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 159, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 54 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L159" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 101, + "name": "dispatches", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize the API error from a failed response.\n" + "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n\n" } ] }, - "flags": {}, - "id": 24, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The failed HTTP response from the Apify API." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 25, - "kind": 32768, - "kindString": "Parameter", - "name": "response", - "type": { - "name": "HttpResponse", - "type": "reference", - "target": "1805" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attempt number when the request failed (1-indexed)." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 26, - "kind": 32768, - "kindString": "Parameter", - "name": "attempt", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP method of the failed request." - } - ] - }, - "defaultValue": "'GET'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 27, - "kind": 32768, - "kindString": "Parameter", - "name": "method", - "type": { - "name": "str", - "type": "reference" - } - } - ], "type": { - "name": "None", - "type": "reference" + "type": "reference", + "name": "WebhookDispatchCollectionClient", + "id": 12 }, - "inheritedFrom": { - "name": "ApifyApiError.__init__", - "target": 23, - "type": "reference" - } + "parameters": [] } - ], - "inheritedFrom": { - "name": "ApifyApiError.__init__", - "target": 23, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Raised when the Apify API returns an HTTP 409 Conflict response." - } - ] - }, - "decorations": [ - { - "args": "('Errors')", - "name": "docs_group" + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 4176, - 4175 - ], - "title": "Methods" + 96, + 100, + 82, + 98, + 84 + ] } ], - "id": 32, - "module": "errors", - "name": "ConflictError", - "parsedDocstring": { - "text": "Raised when the Apify API returns an HTTP 409 Conflict response." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 62, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 114 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ApifyApiError", - "target": "17", - "type": "reference" + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L62" } ] }, { + "id": 102, + "name": "WebhookClientAsync", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single webhook." + } + ] + }, "children": [ { + "id": 103, + "name": "get", + "module": "apify_client.clients.resource_clients.webhook", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n\nReturns:\n The retrieved webhook, or None if it does not exist." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 4177, - "module": "errors", - "name": "__new__", - "parsedDocstring": { - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 179, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 42 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L179" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 104, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n\n" } ] }, - "flags": {}, - "id": 19, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__new__", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 20, - "kind": 32768, - "kindString": "Parameter", - "name": "response", - "type": { - "name": "HttpResponse", - "type": "reference", - "target": "1805" - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 21, - "kind": 32768, - "kindString": "Parameter", - "name": "attempt", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "defaultValue": "'GET'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 22, - "kind": 32768, - "kindString": "Parameter", - "name": "method", - "type": { - "name": "str", - "type": "reference" - } - } - ], "type": { - "name": "Self", - "type": "reference" + "type": "reference", + "name": "dict | None" }, - "inheritedFrom": { - "name": "ApifyApiError.__new__", - "target": 18, - "type": "reference" - } + "parameters": [] } - ], - "inheritedFrom": { - "name": "ApifyApiError.__new__", - "target": 18, - "type": "reference" - } + ] }, { + "id": 105, + "name": "update", + "module": "apify_client.clients.resource_clients.webhook", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize the API error from a failed response.\n" + "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n\nArgs:\n event_types: List of event types that should trigger the webhook. At least one is required.\n request_url: URL that will be invoked once the webhook is triggered.\n payload_template: Specification of the payload that will be sent to request_url.\n headers_template: Headers that will be sent to the request_url.\n actor_id: Id of the Actor whose runs should trigger the webhook.\n actor_task_id: Id of the Actor task whose runs should trigger the webhook.\n actor_run_id: Id of the Actor run which should trigger the webhook.\n ignore_ssl_errors: Whether the webhook should ignore SSL errors returned by request_url.\n do_not_retry: Whether the webhook should retry sending the payload to request_url upon failure.\n is_ad_hoc: Set to True if you want the webhook to be triggered only the first time the condition\n is fulfilled. Only applicable when actor_run_id is filled.\n\nReturns:\n The updated webhook." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 4178, - "module": "errors", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the API error from a failed response.\n", - "args": { - "response": "The failed HTTP response from the Apify API.", - "attempt": "The attempt number when the request failed (1-indexed).", - "method": "The HTTP method of the failed request." - } - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 189, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 54 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L189" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 106, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize the API error from a failed response.\n" + "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n\n" } ] }, - "flags": {}, - "id": 24, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", + "type": { + "type": "intrinsic", + "name": "dict" + }, "parameters": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The failed HTTP response from the Apify API." - } - ] + "id": 107, + "name": "event_types", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[WebhookEventType] | None" }, + "defaultValue": "None" + }, + { + "id": 108, + "name": "request_url", + "kind": 32768, + "kindString": "Parameter", "flags": { - "isOptional": false, - "keyword-only": false + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" }, - "id": 25, + "defaultValue": "None" + }, + { + "id": 109, + "name": "payload_template", "kind": 32768, "kindString": "Parameter", - "name": "response", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "HttpResponse", "type": "reference", - "target": "1805" - } + "name": "str | None" + }, + "defaultValue": "None" }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attempt number when the request failed (1-indexed)." - } - ] + "id": 110, + "name": "headers_template", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" }, + "defaultValue": "None" + }, + { + "id": 111, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", "flags": { - "isOptional": false, - "keyword-only": false + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" }, - "id": 26, + "defaultValue": "None" + }, + { + "id": 112, + "name": "actor_task_id", "kind": 32768, "kindString": "Parameter", - "name": "attempt", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "int", - "type": "reference" - } + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP method of the failed request." - } - ] + "id": 113, + "name": "actor_run_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" }, - "defaultValue": "'GET'", + "defaultValue": "None" + }, + { + "id": 114, + "name": "ignore_ssl_errors", + "kind": 32768, + "kindString": "Parameter", "flags": { - "isOptional": true, - "keyword-only": true + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" }, - "id": 27, + "defaultValue": "None" + }, + { + "id": 115, + "name": "do_not_retry", "kind": 32768, "kindString": "Parameter", - "name": "method", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "str", - "type": "reference" - } + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 116, + "name": "is_ad_hoc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" } - ], - "type": { - "name": "None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ApifyApiError.__init__", - "target": 23, - "type": "reference" - } + ] } - ], - "inheritedFrom": { - "name": "ApifyApiError.__init__", - "target": 23, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Raised when the Apify API returns an HTTP 429 Too Many Requests response.\n\nRate-limited requests are retried automatically; this error is only raised after all retry attempts have been\nexhausted." - } - ] - }, - "decorations": [ - { - "args": "('Errors')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4178, - 4177 - ], - "title": "Methods" - } - ], - "id": 33, - "module": "errors", - "name": "RateLimitError", - "parsedDocstring": { - "text": "Raised when the Apify API returns an HTTP 429 Too Many Requests response.\n\nRate-limited requests are retried automatically; this error is only raised after all retry attempts have been\nexhausted." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 119 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ApifyApiError", - "target": "17", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + ] + }, { + "id": 117, + "name": "delete", + "module": "apify_client.clients.resource_clients.webhook", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook" } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 4179, - "module": "errors", - "name": "__new__", - "parsedDocstring": { - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 238, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 42 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L238" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 118, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook" } ] }, - "flags": {}, - "id": 19, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__new__", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 20, - "kind": 32768, - "kindString": "Parameter", - "name": "response", - "type": { - "name": "HttpResponse", - "type": "reference", - "target": "1805" - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 21, - "kind": 32768, - "kindString": "Parameter", - "name": "attempt", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "defaultValue": "'GET'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 22, - "kind": 32768, - "kindString": "Parameter", - "name": "method", - "type": { - "name": "str", - "type": "reference" - } - } - ], "type": { - "name": "Self", - "type": "reference" + "type": "reference", + "name": "None" }, - "inheritedFrom": { - "name": "ApifyApiError.__new__", - "target": 18, - "type": "reference" - } + "parameters": [] } - ], - "inheritedFrom": { - "name": "ApifyApiError.__new__", - "target": 18, - "type": "reference" - } + ] }, { + "id": 119, + "name": "test", + "module": "apify_client.clients.resource_clients.webhook", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize the API error from a failed response.\n" + "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n\nReturns:\n The webhook dispatch created by the test." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 4180, - "module": "errors", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the API error from a failed response.\n", - "args": { - "response": "The failed HTTP response from the Apify API.", - "attempt": "The attempt number when the request failed (1-indexed).", - "method": "The HTTP method of the failed request." - } - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 245, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 54 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L245" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 120, + "name": "test", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize the API error from a failed response.\n" + "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n\n" } ] }, - "flags": {}, - "id": 24, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The failed HTTP response from the Apify API." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 25, - "kind": 32768, - "kindString": "Parameter", - "name": "response", - "type": { - "name": "HttpResponse", - "type": "reference", - "target": "1805" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attempt number when the request failed (1-indexed)." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 26, - "kind": 32768, - "kindString": "Parameter", - "name": "attempt", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP method of the failed request." - } - ] - }, - "defaultValue": "'GET'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 27, - "kind": 32768, - "kindString": "Parameter", - "name": "method", - "type": { - "name": "str", - "type": "reference" - } - } - ], "type": { - "name": "None", - "type": "reference" + "type": "reference", + "name": "dict | None" }, - "inheritedFrom": { - "name": "ApifyApiError.__init__", - "target": 23, - "type": "reference" + "parameters": [] + } + ] + }, + { + "id": 121, + "name": "dispatches", + "module": "apify_client.clients.resource_clients.webhook", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n\nReturns:\n A client allowing access to dispatches of this webhook using its list method." } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 269, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L269" } ], - "inheritedFrom": { - "name": "ApifyApiError.__init__", - "target": 23, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Raised when the Apify API returns an HTTP 5xx response.\n\nServer errors are retried automatically; this error is only raised after all retry attempts have been exhausted." - } - ] - }, - "decorations": [ - { - "args": "('Errors')", - "name": "docs_group" + "signatures": [ + { + "id": 122, + "name": "dispatches", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookDispatchCollectionClientAsync", + "id": 18 + }, + "parameters": [] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 4180, - 4179 - ], - "title": "Methods" + 117, + 121, + 103, + 119, + 105 + ] } ], - "id": 34, - "module": "errors", - "name": "ServerError", - "parsedDocstring": { - "text": "Raised when the Apify API returns an HTTP 5xx response.\n\nServer errors are retried automatically; this error is only raised after all retry attempts have been exhausted." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/webhook.py", + "line": 172, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 128 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ApifyApiError", - "target": "17", - "type": "reference" + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/webhook.py#L172" } ] }, { + "id": 123, + "name": "UserClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for querying user data." + } + ] + }, "children": [ { + "id": 124, + "name": "get", + "module": "apify_client.clients.resource_clients.user", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize the error from an unparsable response.\n" + "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n\nReturns:\n The retrieved user data, or None if the user does not exist." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 36, - "module": "errors", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the error from an unparsable response.\n", - "args": { - "response": "The HTTP response whose body could not be parsed." - } - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 25, "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 144 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L25" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 125, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize the error from an unparsable response.\n" + "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n\n" } ] }, - "flags": {}, - "id": 37, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] + }, + { + "id": 126, + "name": "monthly_usage", + "module": "apify_client.clients.resource_clients.user", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n\nReturns:\n The retrieved request, or None, if it did not exist." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 37, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L37" + } + ], + "signatures": [ + { + "id": 127, + "name": "monthly_usage", + "modifiers": [], "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP response whose body could not be parsed." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 38, - "kind": 32768, - "kindString": "Parameter", - "name": "response", - "type": { - "name": "HttpResponse", - "type": "reference", - "target": "1805" + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n\n" } - } - ], + ] + }, "type": { - "name": "None", - "type": "literal", - "value": null - } + "type": "reference", + "name": "dict | None" + }, + "parameters": [] } ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error raised when a response body cannot be parsed.\n\nThis typically occurs when the API returns a partial or malformed JSON response, for example due to a network\ninterruption. The client retries such requests automatically, so this error is only raised after all retry\nattempts have been exhausted." - } - ] - }, - "decorations": [ - { - "args": "('Errors')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 36 - ], - "title": "Methods" - } - ], - "id": 35, - "module": "errors", - "name": "InvalidResponseBodyError", - "parsedDocstring": { - "text": "Error raised when a response body cannot be parsed.\n\nThis typically occurs when the API returns a partial or malformed JSON response, for example due to a network\ninterruption. The client retries such requests automatically, so this error is only raised after all retry\nattempts have been exhausted." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/errors.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 136 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ApifyClientError", - "target": "16", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + }, { + "id": 128, + "name": "limits", + "module": "apify_client.clients.resource_clients.user", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n\nReturns:\n The retrieved request, or None, if it did not exist." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 40, - "module": "_streamed_log", - "name": "__init__", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 62, "character": 1, - "fileName": "/src/apify_client/_streamed_log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 26 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L62" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { - "flags": {}, - "id": 41, + "id": 129, + "name": "limits", + "modifiers": [], "kind": 4096, "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 42, - "kind": 32768, - "kindString": "Parameter", - "name": "to_logger", - "type": { - "name": "logging.Logger", - "type": "reference" - } - }, - { - "defaultValue": "True", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 43, - "kind": 32768, - "kindString": "Parameter", - "name": "from_start", - "type": { - "name": "bool", - "type": "reference" + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n\n" } - } - ], + ] + }, "type": { - "name": "None", - "type": "literal", - "value": null - } + "type": "reference", + "name": "dict | None" + }, + "parameters": [] } ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base class for streaming and buffering chunked Actor run logs." - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 40 - ], - "title": "Methods" - } - ], - "id": 39, - "module": "_streamed_log", - "name": "StreamedLogBase", - "parsedDocstring": { - "text": "Base class for streaming and buffering chunked Actor run logs." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_streamed_log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 20 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "StreamedLog", - "target": "44", - "type": "reference" }, { - "name": "StreamedLogAsync", - "target": "61", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { + "id": 130, + "name": "update_limits", + "module": "apify_client.clients.resource_clients.user", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize `StreamedLog`.\n" + "text": "Update the account's limits manageable on your account's Limits page." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 45, - "module": "_streamed_log", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize `StreamedLog`.\n", - "args": { - "log_client": "The log client used to stream raw log data from the Actor run.", - "to_logger": "The logger to which the log messages will be forwarded.", - "from_start": "If `True`, all logs from the start of the Actor run will be streamed. If `False`, only newly\narrived logs will be streamed. This can be useful for long-running Actors in stand-by mode where only\nrecent logs are relevant." - } - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 86, "character": 1, - "fileName": "/src/apify_client/_streamed_log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 93 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L86" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 131, + "name": "update_limits", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize `StreamedLog`.\n" + "text": "Update the account's limits manageable on your account's Limits page." } ] }, - "flags": {}, - "id": 46, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", + "type": { + "type": "reference", + "name": "None" + }, "parameters": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The log client used to stream raw log data from the Actor run." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 47, + "id": 132, + "name": "max_monthly_usage_usd", "kind": 32768, "kindString": "Parameter", - "name": "log_client", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "LogClient", "type": "reference", - "target": "2160" - } + "name": "int | None" + }, + "defaultValue": "None" }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The logger to which the log messages will be forwarded." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 48, + "id": 133, + "name": "data_retention_days", "kind": 32768, "kindString": "Parameter", - "name": "to_logger", - "type": { - "name": "logging.Logger", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If `True`, all logs from the start of the Actor run will be streamed. If `False`, only newly\narrived logs will be streamed. This can be useful for long-running Actors in stand-by mode where only\nrecent logs are relevant." - } - ] - }, - "defaultValue": "True", "flags": { - "isOptional": true, - "keyword-only": true + "keyword-only": "true" }, - "id": 49, - "kind": 32768, - "kindString": "Parameter", - "name": "from_start", "type": { - "name": "bool", - "type": "reference" - } + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "StreamedLogBase.__init__", - "target": 40, - "type": "reference" - } + ] } - ], - "overwrites": { - "name": "StreamedLogBase.__init__", - "target": 40, - "type": "reference" + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 124, + 128, + 126, + 130 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 15, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L15" + } + ] + }, + { + "id": 134, + "name": "UserClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for querying user data." } - }, + ] + }, + "children": [ { + "id": 135, + "name": "get", + "module": "apify_client.clients.resource_clients.user", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Start the streaming thread.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." + "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n\nReturns:\n The retrieved user data, or None if the user does not exist." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 50, - "module": "_streamed_log", - "name": "start", - "parsedDocstring": { - "text": "Start the streaming thread.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 116, "character": 1, - "fileName": "/src/apify_client/_streamed_log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 108 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L116" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 136, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Start the streaming thread.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." + "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n\n" } ] }, - "flags": {}, - "id": 51, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "start", - "parameters": [], "type": { - "name": "Thread", - "type": "reference" - } + "type": "reference", + "name": "dict | None" + }, + "parameters": [] } ] }, { + "id": 137, + "name": "monthly_usage", + "module": "apify_client.clients.resource_clients.user", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Signal the streaming thread to stop logging and wait for it to finish." + "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n\nReturns:\n The retrieved request, or None, if it did not exist." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 52, - "module": "_streamed_log", - "name": "stop", - "parsedDocstring": { - "text": "Signal the streaming thread to stop logging and wait for it to finish." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 128, "character": 1, - "fileName": "/src/apify_client/_streamed_log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 120 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L128" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 138, + "name": "monthly_usage", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Signal the streaming thread to stop logging and wait for it to finish." + "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n\n" } ] }, - "flags": {}, - "id": 53, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "stop", - "parameters": [], "type": { - "name": "None", - "type": "literal", - "value": null - } + "type": "reference", + "name": "dict | None" + }, + "parameters": [] } ] }, { + "id": 139, + "name": "limits", + "module": "apify_client.clients.resource_clients.user", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Start the streaming thread within the context. Exiting the context will finish the streaming thread." + "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n\nReturns:\n The retrieved request, or None, if it did not exist." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 54, - "module": "_streamed_log", - "name": "__enter__", - "parsedDocstring": { - "text": "Start the streaming thread within the context. Exiting the context will finish the streaming thread." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 153, "character": 1, - "fileName": "/src/apify_client/_streamed_log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 129 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L153" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 140, + "name": "limits", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Start the streaming thread within the context. Exiting the context will finish the streaming thread." + "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n\n" } ] }, - "flags": {}, - "id": 55, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__enter__", - "parameters": [], "type": { - "name": "Self", - "type": "reference" - } + "type": "reference", + "name": "dict | None" + }, + "parameters": [] } ] }, { + "id": 141, + "name": "update_limits", + "module": "apify_client.clients.resource_clients.user", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Stop the streaming thread." + "text": "Update the account's limits manageable on your account's Limits page." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 56, - "module": "_streamed_log", - "name": "__exit__", - "parsedDocstring": { - "text": "Stop the streaming thread." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 177, "character": 1, - "fileName": "/src/apify_client/_streamed_log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 134 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L177" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 142, + "name": "update_limits", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Stop the streaming thread." + "text": "Update the account's limits manageable on your account's Limits page." } ] }, - "flags": {}, - "id": 57, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__exit__", + "type": { + "type": "reference", + "name": "None" + }, "parameters": [ { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 58, + "id": 143, + "name": "max_monthly_usage_usd", "kind": 32768, "kindString": "Parameter", - "name": "exc_type", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "type[BaseException] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "type", - "typeArguments": [ - { - "type": "reference", - "name": "BaseException" - } - ], - "target": "474" - }, - { - "type": "literal", - "value": null - } - ] - } + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" }, { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 59, + "id": 144, + "name": "data_retention_days", "kind": 32768, "kindString": "Parameter", - "name": "exc_val", - "type": { - "name": "BaseException | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "BaseException" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { "flags": { - "isOptional": false, - "keyword-only": false + "keyword-only": "true" }, - "id": 60, - "kind": 32768, - "kindString": "Parameter", - "name": "exc_tb", "type": { - "name": "TracebackType | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "TracebackType" - }, - { - "type": "literal", - "value": null - } - ] - } + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } + ] } ] } ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Streams Actor run log output to a Python logger in a background thread.\n\nThe log stream is consumed in a background thread and each log message is forwarded to the provided logger with\nan appropriate log level inferred from the message content.\n\nCan be used as a context manager, which automatically starts and stops the streaming thread. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClient.get_streamed_log`." - } - ] - }, - "decorations": [ - { - "args": "('Other')", - "name": "docs_group" - } - ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 54, - 56, - 45, - 50, - 52 - ], - "title": "Methods" + 135, + 139, + 137, + 141 + ] } ], - "id": 44, - "module": "_streamed_log", - "name": "StreamedLog", - "parsedDocstring": { - "text": "Streams Actor run log output to a Python logger in a background thread.\n\nThe log stream is consumed in a background thread and each log message is forwarded to the provided logger with\nan appropriate log level inferred from the message content.\n\nCan be used as a context manager, which automatically starts and stops the streaming thread. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClient.get_streamed_log`." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/user.py", + "line": 106, "character": 1, - "fileName": "/src/apify_client/_streamed_log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 83 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "StreamedLogBase", - "target": "39", - "type": "reference" + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/user.py#L106" } ] }, { + "id": 145, + "name": "TaskCollectionClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating tasks." + } + ] + }, "children": [ { + "id": 146, + "name": "list", + "module": "apify_client.clients.resource_clients.task_collection", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize `StreamedLogAsync`.\n" + "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n\nArgs:\n limit: How many tasks to list.\n offset: What task to include as first when retrieving the list.\n desc: Whether to sort the tasks in descending order based on their creation date.\n\nReturns:\n The list of available tasks matching the specified filters." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 62, - "module": "_streamed_log", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize `StreamedLogAsync`.\n", - "args": { - "log_client": "The async log client used to stream raw log data from the Actor run.", - "to_logger": "The logger to which the log messages will be forwarded.", - "from_start": "If `True`, all logs from the start of the Actor run will be streamed. If `False`, only newly\narrived logs will be streamed. This can be useful for long-running Actors in stand-by mode where only\nrecent logs are relevant." - } - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task_collection.py", + "line": 20, "character": 1, - "fileName": "/src/apify_client/_streamed_log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 165 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task_collection.py#L20" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 147, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Initialize `StreamedLogAsync`.\n" + "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n\n" } ] }, - "flags": {}, - "id": 63, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, "parameters": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The async log client used to stream raw log data from the Actor run." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 64, + "id": 148, + "name": "limit", "kind": 32768, "kindString": "Parameter", - "name": "log_client", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "LogClientAsync", "type": "reference", - "target": "2177" - } + "name": "int | None" + }, + "defaultValue": "None" }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The logger to which the log messages will be forwarded." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 65, + "id": 149, + "name": "offset", "kind": 32768, "kindString": "Parameter", - "name": "to_logger", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "logging.Logger", - "type": "reference" - } + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" }, { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If `True`, all logs from the start of the Actor run will be streamed. If `False`, only newly\narrived logs will be streamed. This can be useful for long-running Actors in stand-by mode where only\nrecent logs are relevant." - } - ] - }, - "defaultValue": "True", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 66, + "id": 150, + "name": "desc", "kind": 32768, "kindString": "Parameter", - "name": "from_start", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "bool", - "type": "reference" - } + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "StreamedLogBase.__init__", - "target": 40, - "type": "reference" - } + ] } - ], - "overwrites": { - "name": "StreamedLogBase.__init__", - "target": 40, - "type": "reference" - } + ] }, { + "id": 151, + "name": "create", + "module": "apify_client.clients.resource_clients.task_collection", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Start the streaming task.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." + "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n\nArgs:\n actor_id: Id of the Actor that should be run.\n name: Name of the task.\n build: Actor build to run. It can be either a build tag or build number. By default, the run uses\n the build specified in the task settings (typically latest).\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\n in the task settings.\n max_items: Maximum number of results that will be returned by runs of this task. If the Actor of this task\n is charged per result, you will not be charged for more results than the given limit.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the task settings.\n restart_on_error: If true, the Task run process will be restarted whenever it exits with\n a non-zero status code.\n task_input: Task input object.\n title: A human-friendly equivalent of the name.\n actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_max_requests_per_actor_run: The maximum number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_idle_timeout_secs: If the Actor run does not receive any requests for this time,\n it will be shut down.\n actor_standby_build: The build tag or number to run when the Actor is in Standby mode.\n actor_standby_memory_mbytes: The memory in megabytes to use when the Actor is in Standby mode.\n\nReturns:\n The created task." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 67, - "module": "_streamed_log", - "name": "start", - "parsedDocstring": { - "text": "Start the streaming task.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task_collection.py", + "line": 41, "character": 1, - "fileName": "/src/apify_client/_streamed_log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 179 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task_collection.py#L41" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 152, + "name": "create", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Start the streaming task.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." + "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n\n" } ] }, - "flags": {}, - "id": 68, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "start", - "parameters": [], "type": { - "name": "Task", - "type": "reference", - "target": "1197" - } + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 153, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 154, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 155, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 156, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 157, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 158, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 159, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 160, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + }, + { + "id": 161, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 162, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 163, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 164, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 165, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 166, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] } ] - }, + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 151, + 146 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/task_collection.py", + "line": 13, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task_collection.py#L13" + } + ] + }, + { + "id": 167, + "name": "TaskCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating tasks." + } + ] + }, + "children": [ { + "id": 168, + "name": "list", + "module": "apify_client.clients.resource_clients.task_collection", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Stop the streaming task." + "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n\nArgs:\n limit: How many tasks to list.\n offset: What task to include as first when retrieving the list.\n desc: Whether to sort the tasks in descending order based on their creation date.\n\nReturns:\n The list of available tasks matching the specified filters." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 69, - "module": "_streamed_log", - "name": "stop", - "parsedDocstring": { - "text": "Stop the streaming task." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task_collection.py", + "line": 117, "character": 1, - "fileName": "/src/apify_client/_streamed_log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 189 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task_collection.py#L117" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stop the streaming task." - } - ] - }, - "flags": {}, - "id": 70, - "kind": 4096, - "kindString": "Call signature", + "id": 169, + "name": "list", "modifiers": [ "async" ], - "name": "stop", - "parameters": [], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start the streaming task within the context. Exiting the context will cancel the streaming task." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 71, - "module": "_streamed_log", - "name": "__aenter__", - "parsedDocstring": { - "text": "Start the streaming task within the context. Exiting the context will cancel the streaming task." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_streamed_log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 202 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Start the streaming task within the context. Exiting the context will cancel the streaming task." + "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n\n" } ] }, - "flags": {}, - "id": 72, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "__aenter__", - "parameters": [], "type": { - "name": "Self", - "type": "reference" - } + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 170, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 171, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 172, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] } ] }, { + "id": 173, + "name": "create", + "module": "apify_client.clients.resource_clients.task_collection", "kind": 2048, "kindString": "Method", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Cancel the streaming task." + "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n\nArgs:\n actor_id: Id of the Actor that should be run.\n name: Name of the task.\n build: Actor build to run. It can be either a build tag or build number. By default, the run uses\n the build specified in the task settings (typically latest).\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\n in the task settings.\n max_items: Maximum number of results that will be returned by runs of this task. If the Actor of this task\n is charged per result, you will not be charged for more results than the given limit.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the task settings.\n restart_on_error: If true, the Task run process will be restarted whenever it exits with\n a non-zero status code.\n task_input: Task input object.\n title: A human-friendly equivalent of the name.\n actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_max_requests_per_actor_run: The maximum number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_idle_timeout_secs: If the Actor run does not receive any requests for this time,\n it will be shut down.\n actor_standby_build: The build tag or number to run when the Actor is in Standby mode.\n actor_standby_memory_mbytes: The memory in megabytes to use when the Actor is in Standby mode.\n\nReturns:\n The created task." } ] }, - "decorations": [], - "flags": {}, + "children": [], "groups": [], - "id": 73, - "module": "_streamed_log", - "name": "__aexit__", - "parsedDocstring": { - "text": "Cancel the streaming task." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task_collection.py", + "line": 138, "character": 1, - "fileName": "/src/apify_client/_streamed_log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 207 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task_collection.py#L138" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, "signatures": [ { + "id": 174, + "name": "create", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Cancel the streaming task." + "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n\n" } ] }, - "flags": {}, - "id": 74, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "__aexit__", + "type": { + "type": "intrinsic", + "name": "dict" + }, "parameters": [ { + "id": 175, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", "flags": { - "isOptional": false, - "keyword-only": false + "keyword-only": "true" }, - "id": 75, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 176, + "name": "name", "kind": 32768, "kindString": "Parameter", - "name": "exc_type", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "type[BaseException] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "type", - "typeArguments": [ - { - "type": "reference", - "name": "BaseException" - } - ], - "target": "474" - }, - { - "type": "literal", - "value": null - } - ] + "type": "intrinsic", + "name": "str" } }, { + "id": 177, + "name": "build", + "kind": 32768, + "kindString": "Parameter", "flags": { - "isOptional": false, - "keyword-only": false + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" }, - "id": 76, + "defaultValue": "None" + }, + { + "id": 178, + "name": "timeout_secs", "kind": 32768, "kindString": "Parameter", - "name": "exc_val", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "BaseException | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "BaseException" - }, - { - "type": "literal", - "value": null - } - ] - } + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" }, { + "id": 179, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", "flags": { - "isOptional": false, - "keyword-only": false + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" }, - "id": 77, + "defaultValue": "None" + }, + { + "id": 180, + "name": "max_items", "kind": 32768, "kindString": "Parameter", - "name": "exc_tb", + "flags": { + "keyword-only": "true" + }, "type": { - "name": "TracebackType | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "TracebackType" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Streams Actor run log output to a Python logger in an asyncio task.\n\nThe log stream is consumed in a background asyncio task and each log message is forwarded to the provided logger\nwith an appropriate log level inferred from the message content.\n\nCan be used as an async context manager, which automatically starts and cancels the streaming task. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClientAsync.get_streamed_log`." - } - ] - }, - "decorations": [ - { - "args": "('Other')", - "name": "docs_group" + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 181, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 182, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + }, + { + "id": 183, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 184, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 185, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 186, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 187, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 188, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 71, - 73, - 62, - 67, - 69 - ], - "title": "Methods" + 173, + 168 + ] } ], - "id": 61, - "module": "_streamed_log", - "name": "StreamedLogAsync", - "parsedDocstring": { - "text": "Streams Actor run log output to a Python logger in an asyncio task.\n\nThe log stream is consumed in a background asyncio task and each log message is forwarded to the provided logger\nwith an appropriate log level inferred from the message content.\n\nCan be used as an async context manager, which automatically starts and cancels the streaming task. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClientAsync.get_streamed_log`." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task_collection.py", + "line": 110, "character": 1, - "fileName": "/src/apify_client/_streamed_log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 155 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "StreamedLogBase", - "target": "39", - "type": "reference" + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task_collection.py#L110" } ] }, { - "kind": 128, - "kindString": "Class", - "children": [ + "id": 189, + "name": "get_task_representation", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the dictionary representation of a task." + } + ] + }, + "children": [], + "groups": [], + "sources": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 26, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L26" + } + ], + "signatures": [ + { + "id": 190, + "name": "get_task_representation", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + "text": "Get the dictionary representation of a task." } ] }, - "flags": {}, - "groups": [], - "id": 79, - "module": "_typeddicts", - "name": "unique_key", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + "type": { + "type": "intrinsic", + "name": "dict" }, - "sources": [ + "parameters": [ { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 12 - } - ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { + "id": 191, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { "type": "reference", - "name": "str" - } - ] + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 192, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 193, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + }, + { + "id": 194, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 195, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 196, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 197, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 198, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 199, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 200, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 201, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 202, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 203, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 204, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 205, + "name": "TaskClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single task." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 206, + "name": "get", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The URL of the request." + "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n\nReturns:\n The retrieved task." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 80, - "module": "_typeddicts", - "name": "url", - "parsedDocstring": { - "text": "The URL of the request." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 73, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 16 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L73" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { + "signatures": [ + { + "id": 207, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" - } - ] - } + "name": "dict | None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 208, + "name": "update", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n\nArgs:\n name: Name of the task.\n build: Actor build to run. It can be either a build tag or build number. By default, the run uses\n the build specified in the task settings (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged per result,\n you will not be charged for more results than the given limit.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\n in the task settings.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the task settings.\n restart_on_error: If true, the Task run process will be restarted whenever it exits with\n a non-zero status code.\n task_input: Task input dictionary.\n title: A human-friendly equivalent of the name.\n actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_max_requests_per_actor_run: The maximum number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_idle_timeout_secs: If the Actor run does not receive any requests for this time,\n it will be shut down.\n actor_standby_build: The build tag or number to run when the Actor is in Standby mode.\n actor_standby_memory_mbytes: The memory in megabytes to use when the Actor is in Standby mode.\n\nReturns:\n The updated task." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 81, - "module": "_typeddicts", - "name": "method", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 83, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 20 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L83" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Literal", - "typeArguments": [ + "signatures": [ + { + "id": 209, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": "GET" + "kind": "text", + "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 210, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "HEAD" + "type": { + "type": "reference", + "name": "str | None" }, - { - "type": "literal", - "value": "POST" + "defaultValue": "None" + }, + { + "id": 211, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "PUT" + "type": { + "type": "reference", + "name": "dict | None" }, - { - "type": "literal", - "value": "DELETE" + "defaultValue": "None" + }, + { + "id": 212, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "CONNECT" + "type": { + "type": "reference", + "name": "str | None" }, - { - "type": "literal", - "value": "OPTIONS" + "defaultValue": "None" + }, + { + "id": 213, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "TRACE" + "type": { + "type": "reference", + "name": "int | None" }, - { - "type": "literal", - "value": "PATCH" - } - ] - } - ] - } + "defaultValue": "None" + }, + { + "id": 214, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 215, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 216, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 217, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 218, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 219, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 220, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 221, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 222, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 223, + "name": "delete", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The number of times this request has been retried." + "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 82, - "module": "_typeddicts", - "name": "retry_count", - "parsedDocstring": { - "text": "The number of times this request has been retried." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 148, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 21 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L148" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { + "signatures": [ + { + "id": 224, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task" + } + ] + }, + "type": { "type": "reference", - "name": "int" - } - ] - } + "name": "None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 225, + "name": "start", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The final URL that was loaded, after redirects (if any)." + "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n\nArgs:\n task_input: Task input dictionary.\n build: Specifies the Actor build to run. It can be either a build tag or build number. By default,\n the run uses the build specified in the task settings (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged\n per result, you will not be charged for more results than the given limit.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\n in the task settings.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the task settings.\n restart_on_error: If true, the Task run process will be restarted whenever it exits with\n a non-zero status code.\n wait_for_finish: The maximum number of seconds the server waits for the run to finish. By default,\n it is 0, the maximum value is 60.\n webhooks: Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\n the Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\n If you already have a webhook set up for the Actor or task, you do not have to add it again here.\n Each webhook is represented by a dictionary containing these items:\n * `event_types`: List of ``WebhookEventType`` values which trigger the webhook.\n * `request_url`: URL to which to send the webhook HTTP request.\n * `payload_template`: Optional template for the request payload.\n\nReturns:\n The run object." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 83, - "module": "_typeddicts", - "name": "loaded_url", - "parsedDocstring": { - "text": "The final URL that was loaded, after redirects (if any)." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 155, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 25 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L155" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 226, + "name": "start", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n\n" } ] - } - ] - } + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 227, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + }, + { + "id": 228, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 229, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 230, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 231, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 232, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 233, + "name": "wait_for_finish", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 234, + "name": "webhooks", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 235, + "name": "call", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The request payload, typically used with POST or PUT requests." + "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n\nArgs:\n task_input: Task input dictionary.\n build: Specifies the Actor build to run. It can be either a build tag or build number. By default,\n the run uses the build specified in the task settings (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged per result,\n you will not be charged for more results than the given limit.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\n in the task settings.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the task settings.\n restart_on_error: If true, the Task run process will be restarted whenever it exits with\n a non-zero status code.\n webhooks: Specifies optional webhooks associated with the Actor run, which can be used to receive\n a notification e.g. when the Actor finished or failed. Note: if you already have a webhook set up for\n the Actor or task, you do not have to add it again here.\n wait_secs: The maximum number of seconds the server waits for the task run to finish. If not provided,\n waits indefinitely.\n\nReturns:\n The run object." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 84, - "module": "_typeddicts", - "name": "payload", - "parsedDocstring": { - "text": "The request payload, typically used with POST or PUT requests." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 216, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 29 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L216" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ] - }, + "signatures": [ + { + "id": 236, + "name": "call", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n\n" } ] - } - ] - } + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 237, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + }, + { + "id": 238, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 239, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 240, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 241, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 242, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 243, + "name": "webhooks", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 244, + "name": "wait_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 245, + "name": "get_input", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "HTTP headers sent with the request." + "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n\nReturns:\n Retrieved task input." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 85, - "module": "_typeddicts", - "name": "headers", - "parsedDocstring": { - "text": "HTTP headers sent with the request." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 267, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 33 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L267" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - }, + "signatures": [ + { + "id": 246, + "name": "get_input", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n\n" } ] - } - ] - } + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 247, + "name": "update_input", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n\nReturns:\n Retrieved task input." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 86, - "module": "_typeddicts", - "name": "user_data", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 286, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 37 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L286" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "dict[str, Any]" - } - ] - } + "signatures": [ + { + "id": 248, + "name": "update_input", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 249, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "dict" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 250, + "name": "runs", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Indicates whether the request should not be retried if processing fails." + "text": "Retrieve a client for the runs of this task." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 87, - "module": "_typeddicts", - "name": "no_retry", - "parsedDocstring": { - "text": "Indicates whether the request should not be retried if processing fails." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 302, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 38 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L302" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, + "signatures": [ + { + "id": 251, + "name": "runs", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Retrieve a client for the runs of this task." } ] - } - ] - } + }, + "type": { + "type": "reference", + "name": "RunCollectionClient", + "id": 397 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 252, + "name": "last_run", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Error messages recorded from failed processing attempts." + "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n\nArgs:\n status: Consider only runs with this status.\n origin: Consider only runs started with this origin.\n\nReturns:\n The resource client for the last run of this task." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 88, - "module": "_typeddicts", - "name": "error_messages", - "parsedDocstring": { - "text": "Error messages recorded from failed processing attempts." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 306, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 42 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L306" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ + "signatures": [ + { + "id": 253, + "name": "last_run", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "reference", - "name": "str" + "kind": "text", + "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n\n" } - ], - "target": "2199" - } - ] - } + ] + }, + "type": { + "type": "reference", + "name": "RunClient", + "id": 415 + }, + "parameters": [ + { + "id": 254, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorJobStatus | None" + }, + "defaultValue": "None" + }, + { + "id": 255, + "name": "origin", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "MetaOrigin | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 256, + "name": "webhooks", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The timestamp when the request was marked as handled, if applicable." + "text": "Retrieve a client for webhooks associated with this task." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 89, - "module": "_typeddicts", - "name": "handled_at", - "parsedDocstring": { - "text": "The timestamp when the request was marked as handled, if applicable." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 329, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 46 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L329" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 257, + "name": "webhooks", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Retrieve a client for webhooks associated with this task." } ] - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Typed dicts')", - "name": "docs_group" + }, + "type": { + "type": "reference", + "name": "WebhookCollectionClient", + "id": 30 + }, + "parameters": [] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 88, - 89, - 85, - 83, - 81, - 87, - 84, - 82, - 79, - 80, - 86 - ], - "title": "Properties" + 235, + 223, + 206, + 245, + 252, + 250, + 225, + 208, + 247, + 256 + ] } ], - "id": 78, - "module": "_typeddicts", - "name": "RequestBaseDict", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 66, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 11 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "RequestDict", - "target": "102", - "type": "reference" + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L66" } ] }, { + "id": 258, + "name": "TaskClientAsync", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single task." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 259, + "name": "get", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n\nReturns:\n The retrieved task." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 91, - "module": "_typeddicts", - "name": "uniqueKey", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 341, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 54 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L341" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of the request." - } - ] - }, - "flags": {}, - "groups": [], - "id": 92, - "module": "_typeddicts", - "name": "url", - "parsedDocstring": { - "text": "The URL of the request." - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 58 - } - ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { + "id": 260, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" - } - ] - } + "name": "dict | None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 261, + "name": "update", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n\nArgs:\n name: Name of the task.\n build: Actor build to run. It can be either a build tag or build number. By default, the run uses\n the build specified in the task settings (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged per result,\n you will not be charged for more results than the given limit.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\n in the task settings.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the task settings.\n restart_on_error: If true, the Task run process will be restarted whenever it exits with\n a non-zero status code.\n task_input: Task input dictionary.\n title: A human-friendly equivalent of the name.\n actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_max_requests_per_actor_run: The maximum number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_idle_timeout_secs: If the Actor run does not receive any requests for this time,\n it will be shut down.\n actor_standby_build: The build tag or number to run when the Actor is in Standby mode.\n actor_standby_memory_mbytes: The memory in megabytes to use when the Actor is in Standby mode.\n\nReturns:\n The updated task." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 93, - "module": "_typeddicts", - "name": "method", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 351, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 62 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L351" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Literal", - "typeArguments": [ + "signatures": [ + { + "id": 262, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": "GET" + "kind": "text", + "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 263, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "HEAD" + "type": { + "type": "reference", + "name": "str | None" }, - { - "type": "literal", - "value": "POST" + "defaultValue": "None" + }, + { + "id": 264, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "PUT" + "type": { + "type": "reference", + "name": "dict | None" }, - { - "type": "literal", - "value": "DELETE" + "defaultValue": "None" + }, + { + "id": 265, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "CONNECT" + "type": { + "type": "reference", + "name": "str | None" }, - { - "type": "literal", - "value": "OPTIONS" + "defaultValue": "None" + }, + { + "id": 266, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "TRACE" + "type": { + "type": "reference", + "name": "int | None" }, - { - "type": "literal", - "value": "PATCH" - } - ] - } - ] - } + "defaultValue": "None" + }, + { + "id": 267, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 268, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 269, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 270, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 271, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 272, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 273, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 274, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 275, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 276, + "name": "delete", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The number of times this request has been retried." + "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 94, - "module": "_typeddicts", - "name": "retryCount", - "parsedDocstring": { - "text": "The number of times this request has been retried." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 416, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 63 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L416" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { + "signatures": [ + { + "id": 277, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task" + } + ] + }, + "type": { "type": "reference", - "name": "int" - } - ] - } + "name": "None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 278, + "name": "start", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The final URL that was loaded, after redirects (if any)." + "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n\nArgs:\n task_input: Task input dictionary.\n build: Specifies the Actor build to run. It can be either a build tag or build number. By default,\n the run uses the build specified in the task settings (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged\n per result, you will not be charged for more results than the given limit.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\n in the task settings.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the task settings.\n restart_on_error: If true, the Task run process will be restarted whenever it exits with\n a non-zero status code.\n wait_for_finish: The maximum number of seconds the server waits for the run to finish. By default,\n it is 0, the maximum value is 60.\n webhooks: Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\n the Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\n If you already have a webhook set up for the Actor or task, you do not have to add it again here.\n Each webhook is represented by a dictionary containing these items:\n * `event_types`: List of ``WebhookEventType`` values which trigger the webhook.\n * `request_url`: URL to which to send the webhook HTTP request.\n * `payload_template`: Optional template for the request payload.\n\nReturns:\n The run object." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 95, - "module": "_typeddicts", - "name": "loadedUrl", - "parsedDocstring": { - "text": "The final URL that was loaded, after redirects (if any)." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 423, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 67 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L423" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 279, + "name": "start", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n\n" } ] - } - ] - } + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 280, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + }, + { + "id": 281, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 282, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 283, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 284, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 285, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 286, + "name": "wait_for_finish", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 287, + "name": "webhooks", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 288, + "name": "call", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The request payload, typically used with POST or PUT requests." + "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n\nArgs:\n task_input: Task input dictionary.\n build: Specifies the Actor build to run. It can be either a build tag or build number. By default,\n the run uses the build specified in the task settings (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged per result,\n you will not be charged for more results than the given limit.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\n in the task settings.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the task settings.\n restart_on_error: If true, the Task run process will be restarted whenever it exits with\n a non-zero status code.\n webhooks: Specifies optional webhooks associated with the Actor run, which can be used to receive\n a notification e.g. when the Actor finished or failed. Note: if you already have a webhook set up for\n the Actor or task, you do not have to add it again here.\n wait_secs: The maximum number of seconds the server waits for the task run to finish. If not provided,\n waits indefinitely.\n\nReturns:\n The run object." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 96, - "module": "_typeddicts", - "name": "payload", - "parsedDocstring": { - "text": "The request payload, typically used with POST or PUT requests." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 484, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 71 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L484" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ] - }, + "signatures": [ + { + "id": 289, + "name": "call", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n\n" } ] - } - ] - } + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 290, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + }, + { + "id": 291, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 292, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 293, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 294, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 295, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 296, + "name": "webhooks", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 297, + "name": "wait_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 298, + "name": "get_input", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "HTTP headers sent with the request." + "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n\nReturns:\n Retrieved task input." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 97, - "module": "_typeddicts", - "name": "headers", - "parsedDocstring": { - "text": "HTTP headers sent with the request." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 535, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 75 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L535" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - }, + "signatures": [ + { + "id": 299, + "name": "get_input", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n\n" } ] - } - ] - } + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 300, + "name": "update_input", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n\nReturns:\n Retrieved task input." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 98, - "module": "_typeddicts", - "name": "userData", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 554, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 79 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L554" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "dict[str, Any]" - } - ] - } + "signatures": [ + { + "id": 301, + "name": "update_input", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 302, + "name": "task_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "dict" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 303, + "name": "runs", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Indicates whether the request should not be retried if processing fails." + "text": "Retrieve a client for the runs of this task." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 99, - "module": "_typeddicts", - "name": "noRetry", - "parsedDocstring": { - "text": "Indicates whether the request should not be retried if processing fails." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 570, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 80 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L570" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, + "signatures": [ + { + "id": 304, + "name": "runs", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Retrieve a client for the runs of this task." } ] - } - ] - } + }, + "type": { + "type": "reference", + "name": "RunCollectionClientAsync", + "id": 406 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 305, + "name": "last_run", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Error messages recorded from failed processing attempts." + "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n\nArgs:\n status: Consider only runs with this status.\n origin: Consider only runs started with this origin.\n\nReturns:\n The resource client for the last run of this task." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 100, - "module": "_typeddicts", - "name": "errorMessages", - "parsedDocstring": { - "text": "Error messages recorded from failed processing attempts." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 574, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 84 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L574" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ + "signatures": [ + { + "id": 306, + "name": "last_run", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "reference", - "name": "str" + "kind": "text", + "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n\n" } - ], - "target": "2199" - } - ] - } + ] + }, + "type": { + "type": "reference", + "name": "RunClientAsync", + "id": 468 + }, + "parameters": [ + { + "id": 307, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorJobStatus | None" + }, + "defaultValue": "None" + }, + { + "id": 308, + "name": "origin", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "MetaOrigin | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 309, + "name": "webhooks", + "module": "apify_client.clients.resource_clients.task", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The timestamp when the request was marked as handled, if applicable." + "text": "Retrieve a client for webhooks associated with this task." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 101, - "module": "_typeddicts", - "name": "handledAt", - "parsedDocstring": { - "text": "The timestamp when the request was marked as handled, if applicable." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 597, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 88 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L597" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 310, + "name": "webhooks", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Retrieve a client for webhooks associated with this task." } ] - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Typed dicts')", - "name": "docs_group" + }, + "type": { + "type": "reference", + "name": "WebhookCollectionClientAsync", + "id": 49 + }, + "parameters": [] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 100, - 101, - 97, - 95, - 93, - 99, - 96, - 94, - 91, - 92, - 98 - ], - "title": "Properties" + 288, + 276, + 259, + 298, + 305, + 303, + 278, + 261, + 300, + 309 + ] } ], - "id": 90, - "module": "_typeddicts", - "name": "RequestBaseCamelDict", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/task.py", + "line": 334, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 53 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "RequestCamelDict", - "target": "104", - "type": "reference" + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/task.py#L334" } ] }, { + "id": 311, + "name": "StoreCollectionClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for Apify store." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier assigned to the request." - } - ] - }, + "id": 312, + "name": "list", + "module": "apify_client.clients.resource_clients.store_collection", + "kind": 2048, + "kindString": "Method", "flags": {}, - "groups": [], - "id": 103, - "module": "_typeddicts", - "name": "id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 98 - } - ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n\nArgs:\n limit: How many Actors to list.\n offset: What Actor to include as first when retrieving the list.\n search: String to search by. The search runs on the following fields: title, name, description, username,\n readme.\n sort_by: Specifies the field by which to sort the results.\n category: Filter by this category.\n username: Filter by this username.\n pricing_model: Filter by this pricing model.\n\nReturns:\n The list of available tasks matching the specified filters." } ] }, - "flags": {}, - "groups": [], - "id": 4156, - "module": "_typeddicts", - "name": "unique_key", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 12 - } - ], - "type": { - "name": "NotRequired[str]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBaseDict.unique_key", - "target": 79, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of the request." - } - ] - }, - "flags": {}, "groups": [], - "id": 4157, - "module": "_typeddicts", - "name": "url", - "parsedDocstring": { - "text": "The URL of the request." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/store_collection.py", + "line": 18, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 16 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/store_collection.py#L18" } ], - "type": { - "name": "NotRequired[str]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBaseDict.url", - "target": 80, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4158, - "module": "_typeddicts", - "name": "method", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 20 - } - ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Literal", - "typeArguments": [ + "id": 313, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": "GET" + "kind": "text", + "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 314, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "HEAD" + "type": { + "type": "reference", + "name": "int | None" }, - { - "type": "literal", - "value": "POST" + "defaultValue": "None" + }, + { + "id": 315, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "PUT" + "type": { + "type": "reference", + "name": "int | None" }, - { - "type": "literal", - "value": "DELETE" + "defaultValue": "None" + }, + { + "id": 316, + "name": "search", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "CONNECT" + "type": { + "type": "reference", + "name": "str | None" }, - { - "type": "literal", - "value": "OPTIONS" + "defaultValue": "None" + }, + { + "id": 317, + "name": "sort_by", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "TRACE" + "type": { + "type": "reference", + "name": "str | None" }, - { - "type": "literal", - "value": "PATCH" - } - ] - } - ] - }, - "inheritedFrom": { - "name": "RequestBaseDict.method", - "target": 81, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of times this request has been retried." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4159, - "module": "_typeddicts", - "name": "retry_count", - "parsedDocstring": { - "text": "The number of times this request has been retried." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 21 + "defaultValue": "None" + }, + { + "id": 318, + "name": "category", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 319, + "name": "username", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 320, + "name": "pricing_model", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "NotRequired[int]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBaseDict.retry_count", - "target": 82, - "type": "reference" - } - }, + ] + } + ], + "groups": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The final URL that was loaded, after redirects (if any)." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4160, - "module": "_typeddicts", - "name": "loaded_url", - "parsedDocstring": { - "text": "The final URL that was loaded, after redirects (if any)." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 25 - } - ], - "type": { - "name": "NotRequired[str | None]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBaseDict.loaded_url", - "target": 83, - "type": "reference" + "title": "Methods", + "children": [ + 312 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/store_collection.py", + "line": 11, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/store_collection.py#L11" + } + ] + }, + { + "id": 321, + "name": "StoreCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for Apify store." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 322, + "name": "list", + "module": "apify_client.clients.resource_clients.store_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The request payload, typically used with POST or PUT requests." + "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n\nArgs:\n limit: How many Actors to list.\n offset: What Actor to include as first when retrieving the list.\n search: String to search by. The search runs on the following fields: title, name, description, username,\n readme.\n sort_by: Specifies the field by which to sort the results.\n category: Filter by this category.\n username: Filter by this username.\n pricing_model: Filter by this pricing model.\n\nReturns:\n The list of available tasks matching the specified filters." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 4161, - "module": "_typeddicts", - "name": "payload", - "parsedDocstring": { - "text": "The request payload, typically used with POST or PUT requests." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/store_collection.py", + "line": 64, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 29 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/store_collection.py#L64" } ], - "type": { - "name": "NotRequired[str | dict[str, Any] | None]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBaseDict.payload", - "target": 84, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP headers sent with the request." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4162, - "module": "_typeddicts", - "name": "headers", - "parsedDocstring": { - "text": "HTTP headers sent with the request." - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 33 + "id": 323, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 324, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 325, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 326, + "name": "search", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 327, + "name": "sort_by", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 328, + "name": "category", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 329, + "name": "username", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 330, + "name": "pricing_model", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "NotRequired[dict[str, Any] | None]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBaseDict.headers", - "target": 85, - "type": "reference" + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 322 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/store_collection.py", + "line": 57, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/store_collection.py#L57" + } + ] + }, + { + "id": 331, + "name": "ScheduleCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating schedules." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 332, + "name": "list", + "module": "apify_client.clients.resource_clients.schedule_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n\nArgs:\n limit: How many schedules to retrieve.\n offset: What schedules to include as first when retrieving the list.\n desc: Whether to sort the schedules in descending order based on their modification date.\n\nReturns:\n The list of available schedules matching the specified filters." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 4163, - "module": "_typeddicts", - "name": "user_data", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/schedule_collection.py", + "line": 20, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 37 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule_collection.py#L20" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "dict[str, Any]" - } - ] - }, - "inheritedFrom": { - "name": "RequestBaseDict.user_data", - "target": 86, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Indicates whether the request should not be retried if processing fails." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4164, - "module": "_typeddicts", - "name": "no_retry", - "parsedDocstring": { - "text": "Indicates whether the request should not be retried if processing fails." - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 38 + "id": 333, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 334, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 335, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 336, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "NotRequired[bool | None]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBaseDict.no_retry", - "target": 87, - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 337, + "name": "create", + "module": "apify_client.clients.resource_clients.schedule_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Error messages recorded from failed processing attempts." + "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n\nArgs:\n cron_expression: The cron expression used by this schedule.\n is_enabled: True if the schedule should be enabled.\n is_exclusive: When set to true, don't start Actor or Actor task if it's still running from the previous\n schedule.\n name: The name of the schedule to create.\n actions: Actors or tasks that should be run on this schedule. See the API documentation for exact structure.\n description: Description of this schedule.\n timezone: Timezone in which your cron expression runs (TZ database name from\n https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n title: Title of this schedule.\n\nReturns:\n The created schedule." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 4165, - "module": "_typeddicts", - "name": "error_messages", - "parsedDocstring": { - "text": "Error messages recorded from failed processing attempts." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/schedule_collection.py", + "line": 41, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 42 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule_collection.py#L41" } ], - "type": { - "name": "NotRequired[list[str]]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBaseDict.error_messages", - "target": 88, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timestamp when the request was marked as handled, if applicable." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4166, - "module": "_typeddicts", - "name": "handled_at", - "parsedDocstring": { - "text": "The timestamp when the request was marked as handled, if applicable." - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 46 + "id": 338, + "name": "create", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 339, + "name": "cron_expression", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 340, + "name": "is_enabled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + } + }, + { + "id": 341, + "name": "is_exclusive", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + } + }, + { + "id": 342, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 343, + "name": "actions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 344, + "name": "description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 345, + "name": "timezone", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 346, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "NotRequired[str | None]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBaseDict.handled_at", - "target": 89, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A request stored in the request queue, including its metadata and processing state." - } - ] - }, - "decorations": [ - { - "args": "('Typed dicts')", - "name": "docs_group" + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 4165, - 4166, - 4162, - 103, - 4160, - 4158, - 4164, - 4161, - 4159, - 4156, - 4157, - 4163 - ], - "title": "Properties" + 337, + 332 + ] } ], - "id": 102, - "module": "_typeddicts", - "name": "RequestDict", - "parsedDocstring": { - "text": "A request stored in the request queue, including its metadata and processing state." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/schedule_collection.py", + "line": 13, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 95 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "RequestBaseDict", - "target": "78", - "type": "reference" + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule_collection.py#L13" } ] }, { + "id": 347, + "name": "ScheduleCollectionClientAsync", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating schedules." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier assigned to the request." - } - ] - }, + "id": 348, + "name": "list", + "module": "apify_client.clients.resource_clients.schedule_collection", + "kind": 2048, + "kindString": "Method", "flags": {}, - "groups": [], - "id": 105, - "module": "_typeddicts", - "name": "id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 108 - } - ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n\nArgs:\n limit: How many schedules to retrieve.\n offset: What schedules to include as first when retrieving the list.\n desc: Whether to sort the schedules in descending order based on their modification date.\n\nReturns:\n The list of available schedules matching the specified filters." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 4145, - "module": "_typeddicts", - "name": "uniqueKey", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/schedule_collection.py", + "line": 96, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 54 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule_collection.py#L96" } ], - "type": { - "name": "NotRequired[str]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBaseCamelDict.uniqueKey", - "target": 91, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of the request." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4146, - "module": "_typeddicts", - "name": "url", - "parsedDocstring": { - "text": "The URL of the request." - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 58 + "id": 349, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 350, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 351, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 352, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "NotRequired[str]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBaseCamelDict.url", - "target": 92, - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 353, + "name": "create", + "module": "apify_client.clients.resource_clients.schedule_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n\nArgs:\n cron_expression: The cron expression used by this schedule.\n is_enabled: True if the schedule should be enabled.\n is_exclusive: When set to true, don't start Actor or Actor task if it's still running from the previous\n schedule.\n name: The name of the schedule to create.\n actions: Actors or tasks that should be run on this schedule. See the API documentation for exact structure.\n description: Description of this schedule.\n timezone: Timezone in which your cron expression runs (TZ database name from\n https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n title: Title of this schedule.\n\nReturns:\n The created schedule." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 4147, - "module": "_typeddicts", - "name": "method", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/schedule_collection.py", + "line": 117, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 62 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule_collection.py#L117" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Literal", - "typeArguments": [ + "signatures": [ + { + "id": 354, + "name": "create", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": "GET" + "kind": "text", + "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 355, + "name": "cron_expression", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "HEAD" + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 356, + "name": "is_enabled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "POST" + "type": { + "type": "intrinsic", + "name": "bool" + } + }, + { + "id": 357, + "name": "is_exclusive", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "PUT" + "type": { + "type": "intrinsic", + "name": "bool" + } + }, + { + "id": 358, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "DELETE" + "type": { + "type": "reference", + "name": "str | None" }, - { - "type": "literal", - "value": "CONNECT" + "defaultValue": "None" + }, + { + "id": 359, + "name": "actions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "OPTIONS" + "type": { + "type": "reference", + "name": "list[dict] | None" }, - { - "type": "literal", - "value": "TRACE" + "defaultValue": "None" + }, + { + "id": 360, + "name": "description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "PATCH" - } - ] - } - ] - }, - "inheritedFrom": { - "name": "RequestBaseCamelDict.method", - "target": 93, - "type": "reference" + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 361, + "name": "timezone", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 362, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 353, + 348 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/schedule_collection.py", + "line": 89, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule_collection.py#L89" + } + ] + }, + { + "id": 363, + "name": "ScheduleClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single schedule." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 364, + "name": "get", + "module": "apify_client.clients.resource_clients.schedule", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The number of times this request has been retried." + "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n\nReturns:\n The retrieved schedule." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 4148, - "module": "_typeddicts", - "name": "retryCount", - "parsedDocstring": { - "text": "The number of times this request has been retried." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 40, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 63 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L40" } ], - "type": { - "name": "NotRequired[int]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBaseCamelDict.retryCount", - "target": 94, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The final URL that was loaded, after redirects (if any)." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4149, - "module": "_typeddicts", - "name": "loadedUrl", - "parsedDocstring": { - "text": "The final URL that was loaded, after redirects (if any)." - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 67 + "id": 365, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] } - ], - "type": { - "name": "NotRequired[str | None]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBaseCamelDict.loadedUrl", - "target": 95, - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 366, + "name": "update", + "module": "apify_client.clients.resource_clients.schedule", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The request payload, typically used with POST or PUT requests." + "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n\nArgs:\n cron_expression: The cron expression used by this schedule.\n is_enabled: True if the schedule should be enabled.\n is_exclusive: When set to true, don't start Actor or Actor task if it's still running from the previous\n schedule.\n name: The name of the schedule to create.\n actions: Actors or tasks that should be run on this schedule. See the API documentation for exact structure.\n description: Description of this schedule.\n timezone: Timezone in which your cron expression runs (TZ database name from\n https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n title: A human-friendly equivalent of the name.\n\nReturns:\n The updated schedule." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 4150, - "module": "_typeddicts", - "name": "payload", - "parsedDocstring": { - "text": "The request payload, typically used with POST or PUT requests." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 50, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 71 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L50" } ], - "type": { - "name": "NotRequired[str | dict[str, Any] | None]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBaseCamelDict.payload", - "target": 96, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP headers sent with the request." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4151, - "module": "_typeddicts", - "name": "headers", - "parsedDocstring": { - "text": "HTTP headers sent with the request." - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 75 + "id": 367, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 368, + "name": "cron_expression", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 369, + "name": "is_enabled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 370, + "name": "is_exclusive", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 371, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 372, + "name": "actions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 373, + "name": "description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 374, + "name": "timezone", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 375, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "NotRequired[dict[str, Any] | None]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBaseCamelDict.headers", - "target": 97, - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 376, + "name": "delete", + "module": "apify_client.clients.resource_clients.schedule", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 4152, - "module": "_typeddicts", - "name": "userData", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 94, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 79 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L94" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "dict[str, Any]" - } - ] - }, - "inheritedFrom": { - "name": "RequestBaseCamelDict.userData", - "target": 98, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Indicates whether the request should not be retried if processing fails." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4153, - "module": "_typeddicts", - "name": "noRetry", - "parsedDocstring": { - "text": "Indicates whether the request should not be retried if processing fails." - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 80 + "id": 377, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] } - ], - "type": { - "name": "NotRequired[bool | None]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBaseCamelDict.noRetry", - "target": 99, - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 378, + "name": "get_log", + "module": "apify_client.clients.resource_clients.schedule", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Error messages recorded from failed processing attempts." + "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n\nReturns:\n Retrieved log of the given schedule." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 4154, - "module": "_typeddicts", - "name": "errorMessages", - "parsedDocstring": { - "text": "Error messages recorded from failed processing attempts." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 101, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 84 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L101" } ], - "type": { - "name": "NotRequired[list[str]]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBaseCamelDict.errorMessages", - "target": 100, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timestamp when the request was marked as handled, if applicable." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4155, - "module": "_typeddicts", - "name": "handledAt", - "parsedDocstring": { - "text": "The timestamp when the request was marked as handled, if applicable." - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 88 + "id": 379, + "name": "get_log", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "list | None" + }, + "parameters": [] } - ], - "type": { - "name": "NotRequired[str | None]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBaseCamelDict.handledAt", - "target": 101, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A request stored in the request queue, including its metadata and processing state." - } - ] - }, - "decorations": [ - { - "args": "('Typed dicts')", - "name": "docs_group" + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 4154, - 4155, - 4151, - 105, - 4149, - 4147, - 4153, - 4150, - 4148, - 4145, - 4146, - 4152 - ], - "title": "Properties" + 376, + 364, + 378, + 366 + ] } ], - "id": 104, - "module": "_typeddicts", - "name": "RequestCamelDict", - "parsedDocstring": { - "text": "A request stored in the request queue, including its metadata and processing state." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 33, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 105 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "RequestBaseCamelDict", - "target": "90", - "type": "reference" + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L33" } ] }, { + "id": 380, + "name": "ScheduleClientAsync", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single schedule." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 381, + "name": "get", + "module": "apify_client.clients.resource_clients.schedule", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique identifier assigned to the request." + "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n\nReturns:\n The retrieved schedule." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 107, - "module": "_typeddicts", - "name": "id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 129, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 118 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L129" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { + "signatures": [ + { + "id": 382, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" - } - ] - } + "name": "dict | None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 383, + "name": "update", + "module": "apify_client.clients.resource_clients.schedule", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n\nArgs:\n cron_expression: The cron expression used by this schedule.\n is_enabled: True if the schedule should be enabled.\n is_exclusive: When set to true, don't start Actor or Actor task if it's still running from the previous\n schedule.\n name: The name of the schedule to create.\n actions: Actors or tasks that should be run on this schedule. See the API documentation for exact structure.\n description: Description of this schedule.\n timezone: Timezone in which your cron expression runs (TZ database name from\n https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n title: A human-friendly equivalent of the name.\n\nReturns:\n The updated schedule." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 108, - "module": "_typeddicts", - "name": "unique_key", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 139, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 122 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L139" } ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], + "signatures": [ + { + "id": 384, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 385, + "name": "cron_expression", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 386, + "name": "is_enabled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 387, + "name": "is_exclusive", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 388, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 389, + "name": "actions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 390, + "name": "description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 391, + "name": "timezone", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 392, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 393, + "name": "delete", + "module": "apify_client.clients.resource_clients.schedule", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The URL of the request." + "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 109, - "module": "_typeddicts", - "name": "url", - "parsedDocstring": { - "text": "The URL of the request." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 183, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 126 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L183" } ], - "type": { - "name": "str", - "type": "reference" - } + "signatures": [ + { + "id": 394, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 395, + "name": "get_log", + "module": "apify_client.clients.resource_clients.schedule", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n\nReturns:\n Retrieved log of the given schedule." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 110, - "module": "_typeddicts", - "name": "method", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 190, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 130 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L190" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PUT" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "CONNECT" - }, - { - "type": "literal", - "value": "OPTIONS" - }, - { - "type": "literal", - "value": "TRACE" - }, + "signatures": [ + { + "id": 396, + "name": "get_log", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": "PATCH" + "kind": "text", + "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n\n" } ] - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A request that failed to be processed during a request queue operation and can be retried." - } - ] - }, - "decorations": [ - { - "args": "('Typed dicts')", - "name": "docs_group" + }, + "type": { + "type": "reference", + "name": "list | None" + }, + "parameters": [] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 107, - 110, - 108, - 109 - ], - "title": "Properties" + 393, + 381, + 395, + 383 + ] } ], - "id": 106, - "module": "_typeddicts", - "name": "RequestDraftDict", - "parsedDocstring": { - "text": "A request that failed to be processed during a request queue operation and can be retried." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/schedule.py", + "line": 122, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 115 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/schedule.py#L122" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 397, + "name": "RunCollectionClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for listing Actor runs." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier assigned to the request." - } - ] - }, + "id": 398, + "name": "list", + "module": "apify_client.clients.resource_clients.run_collection", + "kind": 2048, + "kindString": "Method", "flags": {}, - "groups": [], - "id": 112, - "module": "_typeddicts", - "name": "id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 137 - } - ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n\nArgs:\n limit: How many runs to retrieve.\n offset: What run to include as first when retrieving the list.\n desc: Whether to sort the runs in descending order based on their start date.\n status: Retrieve only runs with the provided statuses.\n started_before: Only return runs started before this date (inclusive).\n started_after: Only return runs started after this date (inclusive).\n\nReturns:\n The retrieved Actor runs." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 113, - "module": "_typeddicts", - "name": "uniqueKey", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run_collection.py", + "line": 23, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 141 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run_collection.py#L23" } ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of the request." - } - ] - }, - "flags": {}, - "groups": [], - "id": 114, - "module": "_typeddicts", - "name": "url", - "parsedDocstring": { - "text": "The URL of the request." - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 145 + "id": 399, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 400, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 401, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 402, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 403, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorJobStatus | list[ActorJobStatus] | None" + }, + "defaultValue": "None" + }, + { + "id": 404, + "name": "started_before", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | datetime | None" + }, + "defaultValue": "None" + }, + { + "id": 405, + "name": "started_after", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | datetime | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "str", - "type": "reference" + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 398 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run_collection.py", + "line": 16, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run_collection.py#L16" + } + ] + }, + { + "id": 406, + "name": "RunCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for listing Actor runs." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 407, + "name": "list", + "module": "apify_client.clients.resource_clients.run_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n\nArgs:\n limit: How many runs to retrieve.\n offset: What run to include as first when retrieving the list.\n desc: Whether to sort the runs in descending order based on their start date.\n status: Retrieve only runs with the provided statuses.\n started_before: Only return runs started before this date (inclusive).\n started_after: Only return runs started after this date (inclusive).\n\nReturns:\n The retrieved Actor runs." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 115, - "module": "_typeddicts", - "name": "method", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run_collection.py", + "line": 74, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 149 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run_collection.py#L74" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Literal", - "typeArguments": [ + "signatures": [ + { + "id": 408, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": "GET" + "kind": "text", + "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 409, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "HEAD" + "type": { + "type": "reference", + "name": "int | None" }, - { - "type": "literal", - "value": "POST" + "defaultValue": "None" + }, + { + "id": 410, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "PUT" + "type": { + "type": "reference", + "name": "int | None" }, - { - "type": "literal", - "value": "DELETE" + "defaultValue": "None" + }, + { + "id": 411, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "CONNECT" + "type": { + "type": "reference", + "name": "bool | None" }, - { - "type": "literal", - "value": "OPTIONS" + "defaultValue": "None" + }, + { + "id": 412, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "TRACE" + "type": { + "type": "reference", + "name": "ActorJobStatus | list[ActorJobStatus] | None" }, - { - "type": "literal", - "value": "PATCH" - } - ] - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A request that failed to be processed during a request queue operation and can be retried." - } - ] - }, - "decorations": [ - { - "args": "('Typed dicts')", - "name": "docs_group" + "defaultValue": "None" + }, + { + "id": 413, + "name": "started_before", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | datetime | None" + }, + "defaultValue": "None" + }, + { + "id": 414, + "name": "started_after", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | datetime | None" + }, + "defaultValue": "None" + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 112, - 115, - 113, - 114 - ], - "title": "Properties" + 407 + ] } ], - "id": 111, - "module": "_typeddicts", - "name": "RequestDraftCamelDict", - "parsedDocstring": { - "text": "A request that failed to be processed during a request queue operation and can be retried." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run_collection.py", + "line": 67, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 134 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run_collection.py#L67" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 415, + "name": "RunClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single Actor run." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 416, + "name": "get", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique identifier assigned to the request." + "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n\nReturns:\n The retrieved Actor run data." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 117, - "module": "_typeddicts", - "name": "id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 46, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 156 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L46" } ], - "type": { - "name": "str", - "type": "reference" - } + "signatures": [ + { + "id": 417, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 418, + "name": "update", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n\nArgs:\n status_message: The new status message for the run.\n is_status_message_terminal: Set this flag to True if this is the final status message of the Actor run.\n general_access: Determines how others can access the run and its storages.\n\nReturns:\n The updated run." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 118, - "module": "_typeddicts", - "name": "unique_key", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 56, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 160 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L56" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A request that should be deleted, identified by its ID." - } - ] - }, - "decorations": [ - { - "args": "('Typed dicts')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 117, - 118 - ], - "title": "Properties" - } - ], - "id": 116, - "module": "_typeddicts", - "name": "RequestDraftDeleteByIdDict", - "parsedDocstring": { - "text": "A request that should be deleted, identified by its ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 153 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ + { + "id": 419, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 420, + "name": "status_message", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 421, + "name": "is_status_message_terminal", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 422, + "name": "general_access", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "RunGeneralAccess | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 423, + "name": "delete", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique identifier assigned to the request." + "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 120, - "module": "_typeddicts", - "name": "id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 83, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 170 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L83" } ], - "type": { - "name": "str", - "type": "reference" - } + "signatures": [ + { + "id": 424, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 425, + "name": "abort", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n\nArgs:\n gracefully: If True, the Actor run will abort gracefully. It will send `aborting` and `persistStates`\n events into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\n to resurrect the run later.\n\nReturns:\n The data of the aborted Actor run." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 121, - "module": "_typeddicts", - "name": "uniqueKey", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 90, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 174 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L90" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A request that should be deleted, identified by its ID." - } - ] - }, - "decorations": [ - { - "args": "('Typed dicts')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 120, - 121 - ], - "title": "Properties" - } - ], - "id": 119, - "module": "_typeddicts", - "name": "RequestDraftDeleteByIdCamelDict", - "parsedDocstring": { - "text": "A request that should be deleted, identified by its ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 167 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ + { + "id": 426, + "name": "abort", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 427, + "name": "gracefully", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 428, + "name": "wait_for_finish", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique identifier assigned to the request." + "text": "Wait synchronously until the run finishes or the server times out.\n\nArgs:\n wait_secs: How long does the client wait for run to finish. None for indefinite.\n\nReturns:\n The Actor run data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\n TIMED_OUT, ABORTED), then the run has not yet finished." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 123, - "module": "_typeddicts", - "name": "id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 105, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 184 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L105" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { + "signatures": [ + { + "id": 429, + "name": "wait_for_finish", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wait synchronously until the run finishes or the server times out.\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" - } - ] - } + "name": "dict | None" + }, + "parameters": [ + { + "id": 430, + "name": "wait_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 431, + "name": "metamorph", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n\nArgs:\n target_actor_id: ID of the target Actor that the run should be transformed into.\n target_actor_build: The build of the target Actor. It can be either a build tag or build number.\n By default, the run uses the build specified in the default run configuration for the target Actor\n (typically the latest build).\n run_input: The input to pass to the new run.\n content_type: The content type of the input.\n\nReturns:\n The Actor run data." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 124, - "module": "_typeddicts", - "name": "unique_key", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 117, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 188 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L117" } ], - "type": { - "name": "str", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A request that should be deleted, identified by its unique key." - } - ] - }, - "decorations": [ - { - "args": "('Typed dicts')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 123, - 124 - ], - "title": "Properties" - } - ], - "id": 122, - "module": "_typeddicts", - "name": "RequestDraftDeleteByUniqueKeyDict", - "parsedDocstring": { - "text": "A request that should be deleted, identified by its unique key." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 181 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ + { + "id": 432, + "name": "metamorph", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 433, + "name": "target_actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 434, + "name": "target_actor_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 435, + "name": "run_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 436, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 437, + "name": "resurrect", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique identifier assigned to the request." + "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n\nArgs:\n build: Which Actor build the resurrected run should use. It can be either a build tag or build number.\n By default, the resurrected run uses the same build as before.\n memory_mbytes: New memory limit for the resurrected run, in megabytes. By default, the resurrected run\n uses the same memory limit as before.\n timeout_secs: New timeout for the resurrected run, in seconds. By default, the resurrected run uses the\n same timeout as before.\n max_items: Maximum number of items that the resurrected pay-per-result run will return. By default, the\n resurrected run uses the same limit as before. Limit can be only increased.\n max_total_charge_usd: Maximum cost for the resurrected pay-per-event run in USD. By default, the\n resurrected run uses the same limit as before. Limit can be only increased.\n restart_on_error: Determines whether the resurrected run will be restarted if it fails.\n By default, the resurrected run uses the same setting as before.\n\nReturns:\n The Actor run data." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 126, - "module": "_typeddicts", - "name": "id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 156, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 198 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L156" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ] - } + "signatures": [ + { + "id": 438, + "name": "resurrect", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 439, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 440, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 441, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 442, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 443, + "name": "max_total_charge_usd", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Decimal | None" + }, + "defaultValue": "None" + }, + { + "id": 444, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 445, + "name": "reboot", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n\nReturns:\n The Actor run data." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 127, - "module": "_typeddicts", - "name": "uniqueKey", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 207, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 202 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L207" } ], - "type": { - "name": "str", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A request that should be deleted, identified by its unique key." - } - ] - }, - "decorations": [ - { - "args": "('Typed dicts')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 126, - 127 - ], - "title": "Properties" - } - ], - "id": 125, - "module": "_typeddicts", - "name": "RequestDraftDeleteByUniqueKeyCamelDict", - "parsedDocstring": { - "text": "A request that should be deleted, identified by its unique key." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 195 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A request that should be deleted." - } - ] - }, - "flags": {}, - "groups": [], - "id": 128, - "module": "_typeddicts", - "name": "RequestDraftDeleteDict", - "parsedDocstring": { - "text": "A request that should be deleted." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 208 - } - ], - "type": { - "name": "TypeAlias", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A request that should be deleted." - } - ] - }, - "flags": {}, - "groups": [], - "id": 129, - "module": "_typeddicts", - "name": "RequestDraftDeleteCamelDict", - "parsedDocstring": { - "text": "A request that should be deleted." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 213 - } - ], - "type": { - "name": "TypeAlias", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 130, - "module": "_typeddicts", - "name": "RequestUserDataDict", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 219 - } - ], - "type": { - "name": "TypeAlias", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 131, - "module": "_typeddicts", - "name": "RequestUserDataCamelDict", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 221 - } - ], - "type": { - "name": "TypeAlias", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 132, - "module": "_typeddicts", - "name": "TaskInputDict", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 224 - } - ], - "type": { - "name": "TypeAlias", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 133, - "module": "_typeddicts", - "name": "TaskInputCamelDict", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 226 - } - ], - "type": { - "name": "TypeAlias", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ + { + "id": 446, + "name": "reboot", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 447, + "name": "dataset", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\nReturns:\n A client allowing access to the default dataset of this Actor run." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 135, - "module": "_typeddicts", - "name": "actor_id", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 221, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 231 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L221" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 448, + "name": "dataset", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\n" } ] - } - ] - } + }, + "type": { + "type": "reference", + "name": "DatasetClient", + "id": 892 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 449, + "name": "key_value_store", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\nReturns:\n A client allowing access to the default key-value store of this Actor run." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 136, - "module": "_typeddicts", - "name": "actor_task_id", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 233, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 232 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L233" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 450, + "name": "key_value_store", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\n" } ] - } - ] - } + }, + "type": { + "type": "reference", + "name": "KeyValueStoreClient", + "id": 772 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 451, + "name": "request_queue", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\nReturns:\n A client allowing access to the default request_queue of this Actor run." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 137, - "module": "_typeddicts", - "name": "actor_run_id", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 245, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 233 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L245" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 452, + "name": "request_queue", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\n" } ] - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Typed dicts')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 135, - 137, - 136 - ], - "title": "Properties" - } - ], - "id": 134, - "module": "_typeddicts", - "name": "WebhookConditionDict", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 230 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + }, + "type": { + "type": "reference", + "name": "RequestQueueClient", + "id": 542 + }, + "parameters": [] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 453, + "name": "log", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\nReturns:\n A client allowing access to the log of this Actor run." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 139, - "module": "_typeddicts", - "name": "actorId", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 257, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 238 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L257" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 454, + "name": "log", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\n" } ] - } - ] - } + }, + "type": { + "type": "reference", + "name": "LogClient", + "id": 662 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 455, + "name": "get_streamed_log", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n `StreamedLog` can be explicitly started and stopped or used as a context manager.\n\nArgs:\n to_logger: `Logger` used for logging the redirected messages. If not provided, a new logger is created\n from_start: If `True`, all logs from the start of the actor run will be redirected. If `False`, only newly\n arrived logs will be redirected. This can be useful for redirecting only a small portion of relevant\n logs for long-running actors in stand-by.\n\nReturns:\n `StreamedLog` instance for redirected logs." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 140, - "module": "_typeddicts", - "name": "actorTaskId", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 269, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 239 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L269" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 456, + "name": "get_streamed_log", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n `StreamedLog` can be explicitly started and stopped or used as a context manager.\n\n" } ] - } - ] - } + }, + "type": { + "type": "reference", + "name": "StreamedLogSync", + "id": 687 + }, + "parameters": [ + { + "id": 457, + "name": "to_logger", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "logging.Logger | None" + }, + "defaultValue": "None" + }, + { + "id": 458, + "name": "from_start", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "True" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 459, + "name": "charge", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n\nReturns:\n Status and message of the charge event." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 141, - "module": "_typeddicts", - "name": "actorRunId", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 296, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 240 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L296" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 460, + "name": "charge", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n\n" } ] - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Typed dicts')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 139, - 141, - 140 - ], - "title": "Properties" - } - ], - "id": 138, - "module": "_typeddicts", - "name": "WebhookConditionCamelDict", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 237 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 461, + "name": "event_name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 462, + "name": "count", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 463, + "name": "idempotency_key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 464, + "name": "get_status_message_watcher", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n\nArgs:\n to_logger: `Logger` used for logging the status and status messages. If not provided, a new logger is\n created.\n check_period: The period with which the status message will be polled.\n\nReturns:\n `StatusMessageWatcher` instance." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 143, - "module": "_typeddicts", - "name": "is_ad_hoc", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 332, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 245 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L332" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, + "signatures": [ + { + "id": 465, + "name": "get_status_message_watcher", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n\n" } ] - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 144, - "module": "_typeddicts", - "name": "event_types", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 246 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { + }, + "type": { "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "ACTOR.BUILD.ABORTED" - }, - { - "type": "literal", - "value": "ACTOR.BUILD.CREATED" - }, - { - "type": "literal", - "value": "ACTOR.BUILD.FAILED" - }, - { - "type": "literal", - "value": "ACTOR.BUILD.SUCCEEDED" - }, - { - "type": "literal", - "value": "ACTOR.BUILD.TIMED_OUT" - }, - { - "type": "literal", - "value": "ACTOR.RUN.ABORTED" - }, - { - "type": "literal", - "value": "ACTOR.RUN.CREATED" - }, - { - "type": "literal", - "value": "ACTOR.RUN.FAILED" - }, - { - "type": "literal", - "value": "ACTOR.RUN.RESURRECTED" - }, - { - "type": "literal", - "value": "ACTOR.RUN.SUCCEEDED" + "name": "StatusMessageWatcherSync", + "id": 733 + }, + "parameters": [ + { + "id": 466, + "name": "to_logger", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "logging.Logger | None" }, - { - "type": "literal", - "value": "ACTOR.RUN.TIMED_OUT" + "defaultValue": "None" + }, + { + "id": 467, + "name": "check_period", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "timedelta" }, - { - "type": "literal", - "value": "TEST" - } - ] - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 145, - "module": "_typeddicts", - "name": "condition", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 262 + "defaultValue": "timedelta(seconds=1)" + } + ] } - ], - "type": { - "name": "WebhookConditionDict", - "type": "reference", - "target": "134" + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 425, + 459, + 447, + 423, + 416, + 464, + 455, + 449, + 453, + 431, + 445, + 451, + 437, + 418, + 428 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 39, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L39" + } + ] + }, + { + "id": 468, + "name": "RunClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single Actor run." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 469, + "name": "get", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n\nReturns:\n The retrieved Actor run data." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 146, - "module": "_typeddicts", - "name": "idempotency_key", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 368, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 263 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L368" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 470, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n\n" } ] - } - ] - } + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 471, + "name": "update", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n\nArgs:\n status_message: The new status message for the run.\n is_status_message_terminal: Set this flag to True if this is the final status message of the Actor run.\n general_access: Determines how others can access the run and its storages.\n\nReturns:\n The updated run." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 147, - "module": "_typeddicts", - "name": "ignore_ssl_errors", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 378, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 264 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L378" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, + "signatures": [ + { + "id": 472, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n\n" } ] - } - ] - } + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 473, + "name": "status_message", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 474, + "name": "is_status_message_terminal", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 475, + "name": "general_access", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "RunGeneralAccess | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 476, + "name": "abort", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n\nArgs:\n gracefully: If True, the Actor run will abort gracefully. It will send `aborting` and `persistStates`\n events into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\n to resurrect the run later.\n\nReturns:\n The data of the aborted Actor run." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 148, - "module": "_typeddicts", - "name": "do_not_retry", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 405, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 265 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L405" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, + "signatures": [ + { + "id": 477, + "name": "abort", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n\n" } ] - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 149, - "module": "_typeddicts", - "name": "request_url", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 266 + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 478, + "name": "gracefully", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "str", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 479, + "name": "wait_for_finish", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Wait synchronously until the run finishes or the server times out.\n\nArgs:\n wait_secs: How long does the client wait for run to finish. None for indefinite.\n\nReturns:\n The Actor run data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\n TIMED_OUT, ABORTED), then the run has not yet finished." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 150, - "module": "_typeddicts", - "name": "payload_template", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 420, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 267 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L420" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 480, + "name": "wait_for_finish", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Wait synchronously until the run finishes or the server times out.\n\n" } ] - } - ] - } + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 481, + "name": "wait_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 482, + "name": "delete", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 151, - "module": "_typeddicts", - "name": "headers_template", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 432, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 268 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L432" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 483, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run" } ] - } - ] - } + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 484, + "name": "metamorph", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n\nArgs:\n target_actor_id: ID of the target Actor that the run should be transformed into.\n target_actor_build: The build of the target Actor. It can be either a build tag or build number.\n By default, the run uses the build specified in the default run configuration for the target Actor\n (typically the latest build).\n run_input: The input to pass to the new run.\n content_type: The content type of the input.\n\nReturns:\n The Actor run data." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 152, - "module": "_typeddicts", - "name": "description", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 439, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 269 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L439" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 485, + "name": "metamorph", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n\n" } ] - } - ] - } + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 486, + "name": "target_actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 487, + "name": "target_actor_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 488, + "name": "run_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 489, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 490, + "name": "resurrect", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n\nArgs:\n build: Which Actor build the resurrected run should use. It can be either a build tag or build number.\n By default, the resurrected run uses the same build as before.\n memory_mbytes: New memory limit for the resurrected run, in megabytes. By default, the resurrected run\n uses the same memory limit as before.\n timeout_secs: New timeout for the resurrected run, in seconds. By default, the resurrected run uses the\n same timeout as before.\n max_items: Maximum number of items that the resurrected pay-per-result run will return. By default, the\n resurrected run uses the same limit as before. Limit can be only increased.\n max_total_charge_usd: Maximum cost for the resurrected pay-per-event run in USD. By default, the\n resurrected run uses the same limit as before. Limit can be only increased.\n restart_on_error: Determines whether the resurrected run will be restarted if it fails.\n By default, the resurrected run uses the same setting as before.\n\nReturns:\n The Actor run data." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 153, - "module": "_typeddicts", - "name": "should_interpolate_strings", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 481, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 270 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L481" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ + "signatures": [ + { + "id": 491, + "name": "resurrect", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null + "kind": "text", + "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n\n" } ] - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Typed dicts')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 145, - 152, - 148, - 144, - 151, - 146, - 147, - 143, - 150, - 149, - 153 - ], - "title": "Properties" - } - ], - "id": 142, - "module": "_typeddicts", - "name": "WebhookCreateDict", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 244 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 155, - "module": "_typeddicts", - "name": "isAdHoc", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 275 - } - ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 492, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": null - } - ] - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 156, - "module": "_typeddicts", - "name": "eventTypes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 276 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "ACTOR.BUILD.ABORTED" + "type": { + "type": "reference", + "name": "str | None" }, - { - "type": "literal", - "value": "ACTOR.BUILD.CREATED" + "defaultValue": "None" + }, + { + "id": 493, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "ACTOR.BUILD.FAILED" + "type": { + "type": "reference", + "name": "int | None" }, - { - "type": "literal", - "value": "ACTOR.BUILD.SUCCEEDED" + "defaultValue": "None" + }, + { + "id": 494, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "ACTOR.BUILD.TIMED_OUT" + "type": { + "type": "reference", + "name": "int | None" }, - { - "type": "literal", - "value": "ACTOR.RUN.ABORTED" + "defaultValue": "None" + }, + { + "id": 495, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "ACTOR.RUN.CREATED" + "type": { + "type": "reference", + "name": "int | None" }, - { - "type": "literal", - "value": "ACTOR.RUN.FAILED" + "defaultValue": "None" + }, + { + "id": 496, + "name": "max_total_charge_usd", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "ACTOR.RUN.RESURRECTED" + "type": { + "type": "reference", + "name": "Decimal | None" }, - { - "type": "literal", - "value": "ACTOR.RUN.SUCCEEDED" + "defaultValue": "None" + }, + { + "id": 497, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "ACTOR.RUN.TIMED_OUT" + "type": { + "type": "reference", + "name": "bool | None" }, - { - "type": "literal", - "value": "TEST" - } - ] - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 157, - "module": "_typeddicts", - "name": "condition", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 292 + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "WebhookConditionCamelDict", - "type": "reference", - "target": "138" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 498, + "name": "reboot", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n\nReturns:\n The Actor run data." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 158, - "module": "_typeddicts", - "name": "idempotencyKey", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 532, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 293 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L532" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 499, + "name": "reboot", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n\n" } ] - } - ] - } + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 500, + "name": "dataset", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\nReturns:\n A client allowing access to the default dataset of this Actor run." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 159, - "module": "_typeddicts", - "name": "ignoreSslErrors", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 546, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 294 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L546" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, + "signatures": [ + { + "id": 501, + "name": "dataset", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\n" } ] - } - ] - } + }, + "type": { + "type": "reference", + "name": "DatasetClientAsync", + "id": 1002 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 502, + "name": "key_value_store", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\nReturns:\n A client allowing access to the default key-value store of this Actor run." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 160, - "module": "_typeddicts", - "name": "doNotRetry", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 558, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 295 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L558" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, + "signatures": [ + { + "id": 503, + "name": "key_value_store", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\n" } ] - } - ] - } + }, + "type": { + "type": "reference", + "name": "KeyValueStoreClientAsync", + "id": 821 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 504, + "name": "request_queue", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\nReturns:\n A client allowing access to the default request_queue of this Actor run." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 161, - "module": "_typeddicts", - "name": "requestUrl", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 570, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 296 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L570" } ], - "type": { - "name": "str", - "type": "reference" - } + "signatures": [ + { + "id": 505, + "name": "request_queue", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "RequestQueueClientAsync", + "id": 602 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 506, + "name": "log", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\nReturns:\n A client allowing access to the log of this Actor run." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 162, - "module": "_typeddicts", - "name": "payloadTemplate", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 582, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 297 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L582" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 507, + "name": "log", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n\n" } ] - } - ] - } + }, + "type": { + "type": "reference", + "name": "LogClientAsync", + "id": 672 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 508, + "name": "get_streamed_log", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n `StreamedLog` can be explicitly started and stopped or used as a context manager.\n\nArgs:\n to_logger: `Logger` used for logging the redirected messages. If not provided, a new logger is created\n from_start: If `True`, all logs from the start of the actor run will be redirected. If `False`, only newly\n arrived logs will be redirected. This can be useful for redirecting only a small portion of relevant\n logs for long-running actors in stand-by.\n\nReturns:\n `StreamedLog` instance for redirected logs." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 163, - "module": "_typeddicts", - "name": "headersTemplate", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 594, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 298 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L594" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 509, + "name": "get_streamed_log", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n `StreamedLog` can be explicitly started and stopped or used as a context manager.\n\n" } ] - } - ] - } + }, + "type": { + "type": "reference", + "name": "StreamedLogAsync", + "id": 699 + }, + "parameters": [ + { + "id": 510, + "name": "to_logger", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "logging.Logger | None" + }, + "defaultValue": "None" + }, + { + "id": 511, + "name": "from_start", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "True" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 512, + "name": "charge", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n\nReturns:\n Status and message of the charge event." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 164, - "module": "_typeddicts", - "name": "description", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 623, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 299 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L623" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 513, + "name": "charge", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n\n" } ] - } - ] - } + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 514, + "name": "event_name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 515, + "name": "count", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 516, + "name": "idempotency_key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 517, + "name": "get_status_message_watcher", + "module": "apify_client.clients.resource_clients.run", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n\nArgs:\n to_logger: `Logger` used for logging the status and status messages. If not provided, a new logger is\n created.\n check_period: The period with which the status message will be polled.\n\nReturns:\n `StatusMessageWatcher` instance." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 165, - "module": "_typeddicts", - "name": "shouldInterpolateStrings", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 658, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 300 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L658" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Typed dicts')", - "name": "docs_group" + "signatures": [ + { + "id": 518, + "name": "get_status_message_watcher", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "StatusMessageWatcherAsync", + "id": 716 + }, + "parameters": [ + { + "id": 519, + "name": "to_logger", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "logging.Logger | None" + }, + "defaultValue": "None" + }, + { + "id": 520, + "name": "check_period", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "timedelta" + }, + "defaultValue": "timedelta(seconds=1)" + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 157, - 164, - 160, - 156, - 163, - 158, - 159, - 155, - 162, - 161, - 165 - ], - "title": "Properties" + 476, + 512, + 500, + 482, + 469, + 517, + 508, + 502, + 506, + 484, + 498, + 504, + 490, + 471, + 479 + ] } ], - "id": 154, - "module": "_typeddicts", - "name": "WebhookCreateCamelDict", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/run.py", + "line": 361, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 274 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/run.py#L361" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 521, + "name": "RequestQueueCollectionClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating request queues." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 522, + "name": "list", + "module": "apify_client.clients.resource_clients.request_queue_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n\nArgs:\n unnamed: Whether to include unnamed request queues in the list.\n limit: How many request queues to retrieve.\n offset: What request queue to include as first when retrieving the list.\n desc: Whether to sort therequest queues in descending order based on their modification date.\n\nReturns:\n The list of available request queues matching the specified filters." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 167, - "module": "_typeddicts", - "name": "event_types", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue_collection.py", + "line": 18, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 311 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue_collection.py#L18" } ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "ACTOR.BUILD.ABORTED" - }, - { - "type": "literal", - "value": "ACTOR.BUILD.CREATED" - }, - { - "type": "literal", - "value": "ACTOR.BUILD.FAILED" - }, + "signatures": [ + { + "id": 523, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": "ACTOR.BUILD.SUCCEEDED" + "kind": "text", + "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 524, + "name": "unnamed", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "ACTOR.BUILD.TIMED_OUT" + "type": { + "type": "reference", + "name": "bool | None" }, - { - "type": "literal", - "value": "ACTOR.RUN.ABORTED" + "defaultValue": "None" + }, + { + "id": 525, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "ACTOR.RUN.CREATED" + "type": { + "type": "reference", + "name": "int | None" }, - { - "type": "literal", - "value": "ACTOR.RUN.FAILED" + "defaultValue": "None" + }, + { + "id": 526, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "ACTOR.RUN.RESURRECTED" + "type": { + "type": "reference", + "name": "int | None" }, - { - "type": "literal", - "value": "ACTOR.RUN.SUCCEEDED" + "defaultValue": "None" + }, + { + "id": 527, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "ACTOR.RUN.TIMED_OUT" + "type": { + "type": "reference", + "name": "bool | None" }, - { - "type": "literal", - "value": "TEST" - } - ] - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL to which the webhook sends its payload." - } - ] - }, - "flags": {}, - "groups": [], - "id": 168, - "module": "_typeddicts", - "name": "request_url", - "parsedDocstring": { - "text": "The URL to which the webhook sends its payload." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 327 + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "str", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 528, + "name": "get_or_create", + "module": "apify_client.clients.resource_clients.request_queue_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Optional template for the JSON payload sent by the webhook." + "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n\nArgs:\n name: The name of the request queue to retrieve or create.\n\nReturns:\n The retrieved or newly-created request queue." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 169, - "module": "_typeddicts", - "name": "payload_template", - "parsedDocstring": { - "text": "Optional template for the JSON payload sent by the webhook." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue_collection.py", + "line": 41, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 331 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue_collection.py#L41" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 529, + "name": "get_or_create", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n\n" } ] - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional template for the HTTP headers sent by the webhook." - } - ] - }, - "flags": {}, - "groups": [], - "id": 170, - "module": "_typeddicts", - "name": "headers_template", - "parsedDocstring": { - "text": "Optional template for the HTTP headers sent by the webhook." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 335 - } - ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 530, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { "type": "reference", - "name": "str" + "name": "str | None" }, - { - "type": "literal", - "value": null - } - ] - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here." - } - ] - }, - "decorations": [ - { - "args": "('Typed dicts')", - "name": "docs_group" + "defaultValue": "None" + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 167, - 170, - 169, - 168 - ], - "title": "Properties" + 528, + 522 + ] } ], - "id": 166, - "module": "_typeddicts", - "name": "WebhookRepresentationDict", - "parsedDocstring": { - "text": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue_collection.py", + "line": 11, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 304 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue_collection.py#L11" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 531, + "name": "RequestQueueCollectionClientAsync", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating request queues." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 532, + "name": "list", + "module": "apify_client.clients.resource_clients.request_queue_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n\nArgs:\n unnamed: Whether to include unnamed request queues in the list.\n limit: How many request queues to retrieve.\n offset: What request queue to include as first when retrieving the list.\n desc: Whether to sort therequest queues in descending order based on their modification date.\n\nReturns:\n The list of available request queues matching the specified filters." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 172, - "module": "_typeddicts", - "name": "eventTypes", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue_collection.py", + "line": 62, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 349 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue_collection.py#L62" } ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "ACTOR.BUILD.ABORTED" - }, - { - "type": "literal", - "value": "ACTOR.BUILD.CREATED" - }, - { - "type": "literal", - "value": "ACTOR.BUILD.FAILED" - }, + "signatures": [ + { + "id": 533, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": "ACTOR.BUILD.SUCCEEDED" + "kind": "text", + "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 534, + "name": "unnamed", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "ACTOR.BUILD.TIMED_OUT" + "type": { + "type": "reference", + "name": "bool | None" }, - { - "type": "literal", - "value": "ACTOR.RUN.ABORTED" + "defaultValue": "None" + }, + { + "id": 535, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "ACTOR.RUN.CREATED" + "type": { + "type": "reference", + "name": "int | None" }, - { - "type": "literal", - "value": "ACTOR.RUN.FAILED" + "defaultValue": "None" + }, + { + "id": 536, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "ACTOR.RUN.RESURRECTED" + "type": { + "type": "reference", + "name": "int | None" }, - { - "type": "literal", - "value": "ACTOR.RUN.SUCCEEDED" + "defaultValue": "None" + }, + { + "id": 537, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { - "type": "literal", - "value": "ACTOR.RUN.TIMED_OUT" + "type": { + "type": "reference", + "name": "bool | None" }, - { - "type": "literal", - "value": "TEST" - } - ] - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL to which the webhook sends its payload." - } - ] - }, - "flags": {}, - "groups": [], - "id": 173, - "module": "_typeddicts", - "name": "requestUrl", - "parsedDocstring": { - "text": "The URL to which the webhook sends its payload." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 365 + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "str", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 538, + "name": "get_or_create", + "module": "apify_client.clients.resource_clients.request_queue_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Optional template for the JSON payload sent by the webhook." + "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n\nArgs:\n name: The name of the request queue to retrieve or create.\n\nReturns:\n The retrieved or newly-created request queue." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 174, - "module": "_typeddicts", - "name": "payloadTemplate", - "parsedDocstring": { - "text": "Optional template for the JSON payload sent by the webhook." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue_collection.py", + "line": 85, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 369 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue_collection.py#L85" } ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 539, + "name": "get_or_create", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n\n" } ] - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional template for the HTTP headers sent by the webhook." - } - ] - }, - "flags": {}, - "groups": [], - "id": 175, - "module": "_typeddicts", - "name": "headersTemplate", - "parsedDocstring": { - "text": "Optional template for the HTTP headers sent by the webhook." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 373 - } - ], - "type": { - "name": "NotRequired", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 540, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { "type": "reference", - "name": "str" + "name": "str | None" }, - { - "type": "literal", - "value": null - } - ] - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here." - } - ] - }, - "decorations": [ - { - "args": "('Typed dicts')", - "name": "docs_group" + "defaultValue": "None" + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 172, - 175, - 174, - 173 - ], - "title": "Properties" + 538, + 532 + ] } ], - "id": 171, - "module": "_typeddicts", - "name": "WebhookRepresentationCamelDict", - "parsedDocstring": { - "text": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue_collection.py", + "line": 55, "character": 1, - "fileName": "/src/apify_client/_typeddicts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 342 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue_collection.py#L55" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 541, + "name": "BatchAddRequestsResult", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 128, + "kindString": "Class", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Default base URL for the Apify API." + "text": "Result of the batch add requests operation.\n\nArgs:\n processedRequests: List of successfully added requests.\n unprocessedRequests: List of requests that failed to be added." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 176, - "module": "_consts", - "name": "DEFAULT_API_URL", - "parsedDocstring": { - "text": "Default base URL for the Apify API." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 36, "character": 1, - "fileName": "/src/apify_client/_consts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 5 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L36" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 542, + "name": "RequestQueueClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Current Apify API version." + "text": "Sub-client for manipulating a single request queue." } ] }, - "flags": {}, - "groups": [], - "id": 177, - "module": "_consts", - "name": "API_VERSION", - "parsedDocstring": { - "text": "Current Apify API version." - }, - "sources": [ + "children": [ { - "character": 1, - "fileName": "/src/apify_client/_consts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 8 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for fast CRUD operations (e.g., get, update, delete)." - } - ] - }, - "flags": {}, - "groups": [], - "id": 178, - "module": "_consts", - "name": "DEFAULT_TIMEOUT_SHORT", - "parsedDocstring": { - "text": "Default timeout for fast CRUD operations (e.g., get, update, delete)." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_consts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 11 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for batch, list, and data transfer operations." - } - ] - }, - "flags": {}, - "groups": [], - "id": 179, - "module": "_consts", - "name": "DEFAULT_TIMEOUT_MEDIUM", - "parsedDocstring": { - "text": "Default timeout for batch, list, and data transfer operations." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_consts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 14 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for long-polling, streaming, and other heavy operations." - } - ] - }, - "flags": {}, - "groups": [], - "id": 180, - "module": "_consts", - "name": "DEFAULT_TIMEOUT_LONG", - "parsedDocstring": { - "text": "Default timeout for long-polling, streaming, and other heavy operations." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_consts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 17 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default maximum timeout cap for individual API requests (limits exponential growth)." - } - ] - }, - "flags": {}, - "groups": [], - "id": 181, - "module": "_consts", - "name": "DEFAULT_TIMEOUT_MAX", - "parsedDocstring": { - "text": "Default maximum timeout cap for individual API requests (limits exponential growth)." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_consts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 20 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default maximum number of retries for failed requests." - } - ] - }, - "flags": {}, - "groups": [], - "id": 182, - "module": "_consts", - "name": "DEFAULT_MAX_RETRIES", - "parsedDocstring": { - "text": "Default maximum number of retries for failed requests." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_consts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 23 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default minimum delay between retries." - } - ] - }, - "flags": {}, - "groups": [], - "id": 183, - "module": "_consts", - "name": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES", - "parsedDocstring": { - "text": "Default minimum delay between retries." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_consts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 26 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default maximum wait time for job completion (effectively infinite)." - } - ] - }, - "flags": {}, - "groups": [], - "id": 184, - "module": "_consts", - "name": "DEFAULT_WAIT_FOR_FINISH", - "parsedDocstring": { - "text": "Default maximum wait time for job completion (effectively infinite)." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_consts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 29 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "How long to wait for a job to exist before giving up." - } - ] - }, - "flags": {}, - "groups": [], - "id": 185, - "module": "_consts", - "name": "DEFAULT_WAIT_WHEN_JOB_NOT_EXIST", - "parsedDocstring": { - "text": "How long to wait for a job to exist before giving up." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_consts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 32 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Headers that can be overridden by users, but will trigger a warning if they do so, as it may lead to API errors." - } - ] - }, - "flags": {}, - "groups": [], - "id": 186, - "module": "_consts", - "name": "OVERRIDABLE_DEFAULT_HEADERS", - "parsedDocstring": { - "text": "Headers that can be overridden by users, but will trigger a warning if they do so, as it may lead to API errors." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_consts.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 35 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 543, + "name": "__init__", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 512, + "kindString": "Constructor", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Initialize a new instance.\n\nArgs:\n client_key: A unique identifier of the client accessing the request queue." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 188, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 51, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 26 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L51" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 544, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 545, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + } + }, + { + "id": 546, + "name": "client_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 547, + "name": "kwargs", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 548, + "name": "get", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n\nReturns:\n The retrieved request queue, or None, if it does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 189, - "module": "_models", - "name": "monthly_usage_cycle", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 66, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 30 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L66" } ], - "type": { - "name": "UsageCycle", - "type": "reference", - "target": "1303" - } + "signatures": [ + { + "id": 549, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 550, + "name": "update", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n\nArgs:\n name: The new name for the request queue.\n general_access: Determines how others can access the request queue.\n\nReturns:\n The updated request queue." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 190, - "module": "_models", - "name": "limits", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 76, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 31 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L76" } ], - "type": { - "name": "Limits", - "type": "reference", - "target": "629" - } + "signatures": [ + { + "id": 551, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 552, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 553, + "name": "general_access", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "StorageGeneralAccess | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 554, + "name": "delete", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 191, - "module": "_models", - "name": "current", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 95, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 32 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L95" } ], - "type": { - "name": "Current", - "type": "reference", - "target": "412" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 191, - 190, - 188, - 189 - ], - "title": "Properties" - } - ], - "id": 187, - "module": "_models", - "name": "AccountLimits", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 25 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ + { + "id": 555, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 556, + "name": "list_head", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n\nArgs:\n limit: How many requests to retrieve.\n\nReturns:\n The desired number of requests from the beginning of the queue." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 193, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 102, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 37 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L102" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 557, + "name": "list_head", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 558, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 559, + "name": "list_and_lock_head", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n\nArgs:\n lock_secs: How long the requests will be locked for, in seconds.\n limit: How many requests to retrieve.\n\nReturns:\n The desired number of locked requests from the beginning of the queue." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 194, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 124, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 41 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L124" } ], - "type": { - "name": "str", - "type": "reference" - } + "signatures": [ + { + "id": 560, + "name": "list_and_lock_head", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 561, + "name": "lock_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "int" + } + }, + { + "id": 562, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 563, + "name": "add_request", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n\nArgs:\n request: The request to add to the queue.\n forefront: Whether to add the request to the head or the end of the queue.\n\nReturns:\n The added request." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 195, - "module": "_models", - "name": "user_id", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 147, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 42 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L147" } ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 196, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 43 + "id": 564, + "name": "add_request", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 565, + "name": "request", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "dict" + } + }, + { + "id": 566, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "str", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 567, + "name": "get_request", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n\nArgs:\n request_id: ID of the request to retrieve.\n\nReturns:\n The retrieved request, or None, if it did not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 197, - "module": "_models", - "name": "username", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 171, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 44 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L171" } ], - "type": { - "name": "str", - "type": "reference" - } + "signatures": [ + { + "id": 568, + "name": "get_request", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 569, + "name": "request_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 570, + "name": "update_request", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n\nArgs:\n request: The updated request.\n forefront: Whether to put the updated request in the beginning or the end of the queue.\n\nReturns:\n The updated request." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 198, - "module": "_models", - "name": "description", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 196, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 45 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L196" } ], - "type": { - "name": "Annotated[str | None, Field(examples=['My favourite actor!'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + "signatures": [ + { + "id": 571, + "name": "update_request", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 572, + "name": "request", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "dict" + } + }, + { + "id": 573, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 574, + "name": "delete_request", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n\nArgs:\n request_id: ID of the request to delete." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 199, - "module": "_models", - "name": "restart_on_error", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 222, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 46 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L222" } ], - "type": { - "name": "Annotated[bool | None, Field(alias='restartOnError', deprecated=True, examples=[False])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 575, + "name": "delete_request", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "bool" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 576, + "name": "request_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 577, + "name": "prolong_request_lock", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n\nArgs:\n request_id: ID of the request to prolong the lock.\n forefront: Whether to put the request in the beginning or the end of the queue after lock expires.\n lock_secs: By how much to prolong the lock, in seconds." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 200, - "module": "_models", - "name": "is_public", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 241, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 47 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L241" } ], - "type": { - "name": "bool", - "type": "reference" - } + "signatures": [ + { + "id": 578, + "name": "prolong_request_lock", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 579, + "name": "request_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 580, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 581, + "name": "lock_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "int" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 582, + "name": "delete_request_lock", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n\nArgs:\n request_id: ID of the request to delete the lock.\n forefront: Whether to put the request in the beginning or the end of the queue after the lock is deleted." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 201, - "module": "_models", - "name": "actor_permission_level", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 268, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 48 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L268" } ], - "type": { - "name": "Annotated[ActorPermissionLevel | None, Field(alias='actorPermissionLevel')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 583, + "name": "delete_request_lock", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "ActorPermissionLevel", - "target": "1795" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 584, + "name": "request_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 585, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 586, + "name": "batch_add_requests", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n\nArgs:\n requests: List of requests to be added to the queue.\n forefront: Whether to add requests to the front of the queue.\n max_parallel: Specifies the maximum number of parallel tasks for API calls. This is only applicable\n to the async client. For the sync client, this value must be set to 1, as parallel execution\n is not supported.\n max_unprocessed_requests_retries: Deprecated argument. Will be removed in next major release.\n min_delay_between_unprocessed_requests_retries: Deprecated argument. Will be removed in next major release.\n\nReturns:\n Result containing lists of processed and unprocessed requests." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 202, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 286, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 49 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L286" } ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 203, - "module": "_models", - "name": "modified_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 50 + "id": 587, + "name": "batch_add_requests", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "BatchAddRequestsResult", + "id": 541 + }, + "parameters": [ + { + "id": 588, + "name": "requests", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "list[dict]" + } + }, + { + "id": 589, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "False" + }, + { + "id": 590, + "name": "max_parallel", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "defaultValue": "1" + }, + { + "id": 591, + "name": "max_unprocessed_requests_retries", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 592, + "name": "min_delay_between_unprocessed_requests_retries", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "timedelta | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 593, + "name": "batch_delete_requests", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n\nArgs:\n requests: List of the requests to delete." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 204, - "module": "_models", - "name": "stats", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 364, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 51 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L364" } ], - "type": { - "name": "ActorStats", - "type": "reference", - "target": "265" - } + "signatures": [ + { + "id": 594, + "name": "batch_delete_requests", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 595, + "name": "requests", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "list[dict]" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 596, + "name": "list_requests", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n\nArgs:\n limit: How many requests to retrieve.\n exclusive_start_id: All requests up to this one (including) are skipped from the result." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 205, - "module": "_models", - "name": "versions", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 384, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 52 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L384" } ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Version", - "target": "1336" - } - ], - "target": "2199" - } + "signatures": [ + { + "id": 597, + "name": "list_requests", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 598, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 599, + "name": "exclusive_start_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 600, + "name": "unlock_requests", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n\nReturns:\n dict: Result of the unlock operation" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 206, - "module": "_models", - "name": "pricing_infos", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 409, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 53 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L409" } ], - "type": { - "name": "Annotated[ list[ Annotated[ PayPerEventActorPricingInfo | PricePerDatasetItemActorPricingInfo | FlatPricePerMonthActorPricingInfo | FreeActorPricingInfo, Field(discriminator='pricing_model'), ] ] | None, Field(alias='pricingInfos'), ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "PayPerEventActorPricingInfo", - "target": "786" - }, - { - "type": "reference", - "name": "PricePerDatasetItemActorPricingInfo", - "target": "813" - } - ] - }, - { - "type": "reference", - "name": "FlatPricePerMonthActorPricingInfo", - "target": "570" - } - ] - }, - { - "type": "reference", - "name": "FreeActorPricingInfo", - "target": "575" - } - ] - } + "signatures": [ + { + "id": 601, + "name": "unlock_requests", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n\n" + } ], - "target": "2199" + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Result of the unlock operation" + } + ] + } + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 543 + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "title": "Methods", + "children": [ + 563, + 586, + 593, + 554, + 574, + 582, + 548, + 567, + 559, + 556, + 596, + 577, + 600, + 550, + 570 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 48, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L48" + } + ] + }, + { + "id": 602, + "name": "RequestQueueClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single request queue." + } + ] + }, + "children": [ + { + "id": 603, + "name": "__init__", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 512, + "kindString": "Constructor", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Initialize a new instance.\n\nArgs:\n client_key: A unique identifier of the client accessing the request queue." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 207, - "module": "_models", - "name": "default_run_options", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 431, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 66 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L431" } ], - "type": { - "name": "DefaultRunOptions", - "type": "reference", - "target": "499" - } + "signatures": [ + { + "id": 604, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 605, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + } + }, + { + "id": 606, + "name": "client_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 607, + "name": "kwargs", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 608, + "name": "get", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n\nReturns:\n The retrieved request queue, or None, if it does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 208, - "module": "_models", - "name": "example_run_input", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 446, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 67 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L446" } ], - "type": { - "name": "Annotated[ExampleRunInput | None, Field(alias='exampleRunInput')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 609, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "ExampleRunInput", - "target": "562" + "name": "dict | None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 610, + "name": "update", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n\nArgs:\n name: The new name for the request queue.\n general_access: Determines how others can access the request queue.\n\nReturns:\n The updated request queue." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 209, - "module": "_models", - "name": "is_deprecated", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 456, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 68 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L456" } ], - "type": { - "name": "Annotated[bool | None, Field(alias='isDeprecated', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" + "signatures": [ + { + "id": 611, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 612, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 613, + "name": "general_access", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "StorageGeneralAccess | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 614, + "name": "delete", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 210, - "module": "_models", - "name": "deployment_key", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 475, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 69 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L475" } ], - "type": { - "name": "Annotated[str | None, Field(alias='deploymentKey', examples=['ssh-rsa AAAA ...'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 615, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 616, + "name": "list_head", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n\nArgs:\n limit: How many requests to retrieve.\n\nReturns:\n The desired number of requests from the beginning of the queue." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 211, - "module": "_models", - "name": "title", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 482, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 70 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L482" } ], - "type": { - "name": "Annotated[str | None, Field(examples=['My Actor'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + "signatures": [ + { + "id": 617, + "name": "list_head", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 618, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 619, + "name": "list_and_lock_head", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n\nArgs:\n lock_secs: How long the requests will be locked for, in seconds.\n limit: How many requests to retrieve.\n\nReturns:\n The desired number of locked requests from the beginning of the queue." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 212, - "module": "_models", - "name": "tagged_builds", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 504, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 71 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L504" } ], - "type": { - "name": "Annotated[dict[str, TaggedBuildInfo | None] | None, Field(alias='taggedBuilds')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 620, + "name": "list_and_lock_head", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "union", - "types": [ - { - "type": "reference", - "name": "TaggedBuildInfo", - "target": "1192" - }, - { - "type": "literal", - "value": null - } - ] + "kind": "text", + "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n\n" } ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 621, + "name": "lock_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "int" + } + }, + { + "id": 622, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 623, + "name": "add_request", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n\nArgs:\n request: The request to add to the queue.\n forefront: Whether to add the request to the head or the end of the queue.\n\nReturns:\n The added request." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 213, - "module": "_models", - "name": "actor_standby", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 527, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L527" } ], - "type": { - "name": "Annotated[ActorStandby | None, Field(alias='actorStandby')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorStandby", - "target": "255" + "signatures": [ + { + "id": 624, + "name": "add_request", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 625, + "name": "request", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "dict" + } + }, + { + "id": 626, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 627, + "name": "get_request", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A brief, LLM-generated readme summary" + "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n\nArgs:\n request_id: ID of the request to retrieve.\n\nReturns:\n The retrieved request, or None, if it did not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 214, - "module": "_models", - "name": "readme_summary", - "parsedDocstring": { - "text": "A brief, LLM-generated readme summary" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 551, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 73 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L551" } ], - "type": { - "name": "Annotated[str | None, Field(alias='readmeSummary')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 628, + "name": "get_request", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "dict | None" }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 201, - 213, - 202, - 207, - 210, - 198, - 208, - 194, - 209, - 200, - 193, - 203, - 196, - 206, - 214, - 199, - 204, - 212, - 211, - 195, - 197, - 205 - ], - "title": "Properties" - } - ], - "id": 192, - "module": "_models", - "name": "Actor", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 36 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "parameters": [ + { + "id": 629, + "name": "request_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 630, + "name": "update_request", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n\nArgs:\n request: The updated request.\n forefront: Whether to put the updated request in the beginning or the end of the queue.\n\nReturns:\n The updated request." } ] }, - "flags": {}, - "groups": [], - "id": 216, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 81 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, "groups": [], - "id": 217, - "module": "_models", - "name": "event_price_usd", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 576, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 85 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L576" } ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 218, - "module": "_models", - "name": "event_title", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 86 + "id": 631, + "name": "update_request", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 632, + "name": "request", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "dict" + } + }, + { + "id": 633, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "str", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 634, + "name": "delete_request", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n\nArgs:\n request_id: ID of the request to delete." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 219, - "module": "_models", - "name": "event_description", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 602, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 87 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L602" } ], - "type": { - "name": "str", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 219, - 217, - 218, - 216 - ], - "title": "Properties" - } - ], - "id": 215, - "module": "_models", - "name": "ActorChargeEvent", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 80 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 221, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 94 + "id": 635, + "name": "delete_request", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 636, + "name": "request_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 637, + "name": "prolong_request_lock", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The Actor specification version that this Actor follows. This property must be set to 1." + "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n\nArgs:\n request_id: ID of the request to prolong the lock.\n forefront: Whether to put the request in the beginning or the end of the queue after lock expires.\n lock_secs: By how much to prolong the lock, in seconds." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 222, - "module": "_models", - "name": "actor_specification", - "parsedDocstring": { - "text": "The Actor specification version that this Actor follows. This property must be set to 1." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 619, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 98 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L619" } ], - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": 1 - } - ] - } + "signatures": [ + { + "id": 638, + "name": "prolong_request_lock", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 639, + "name": "request_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 640, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 641, + "name": "lock_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "int" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 642, + "name": "delete_request_lock", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The name of the Actor." + "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n\nArgs:\n request_id: ID of the request to delete the lock.\n forefront: Whether to put the request in the beginning or the end of the queue after the lock is deleted." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 223, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "The name of the Actor." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 646, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 102 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L646" } ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 643, + "name": "delete_request_lock", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 644, + "name": "request_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 645, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 646, + "name": "batch_add_requests", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The version of the Actor, specified in the format [Number].[Number], e.g., 0.1, 1.0." + "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n\nArgs:\n requests: List of requests to be added to the queue.\n forefront: Whether to add requests to the front of the queue.\n max_parallel: Specifies the maximum number of parallel tasks for API calls. This is only applicable\n to the async client. For the sync client, this value must be set to 1, as parallel execution\n is not supported.\n max_unprocessed_requests_retries: Deprecated argument. Will be removed in next major release.\n min_delay_between_unprocessed_requests_retries: Deprecated argument. Will be removed in next major release.\n\nReturns:\n Result containing lists of processed and unprocessed requests." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 224, - "module": "_models", - "name": "version", - "parsedDocstring": { - "text": "The version of the Actor, specified in the format [Number].[Number], e.g., 0.1, 1.0." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 713, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 106 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L713" } ], - "type": { - "name": "Annotated[str | None, Field(pattern='^[0-9]+\\\\.[0-9]+$')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 647, + "name": "batch_add_requests", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "BatchAddRequestsResult", + "id": 541 }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 648, + "name": "requests", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "list[dict]" + } + }, + { + "id": 649, + "name": "forefront", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "False" + }, + { + "id": 650, + "name": "max_parallel", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "defaultValue": "5" + }, + { + "id": 651, + "name": "max_unprocessed_requests_retries", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 652, + "name": "min_delay_between_unprocessed_requests_retries", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "timedelta | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 653, + "name": "batch_delete_requests", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The tag name to be applied to a successful build of the Actor. Defaults to 'latest' if not specified." + "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n\nArgs:\n requests: List of the requests to delete." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 225, - "module": "_models", - "name": "build_tag", - "parsedDocstring": { - "text": "The tag name to be applied to a successful build of the Actor. Defaults to 'latest' if not specified." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 793, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 110 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L793" } ], - "type": { - "name": "Annotated[str | None, Field(alias='buildTag')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + "signatures": [ + { + "id": 654, + "name": "batch_delete_requests", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 655, + "name": "requests", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "list[dict]" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 656, + "name": "list_requests", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A map of environment variables to be used during local development and deployment." + "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n\nArgs:\n limit: How many requests to retrieve.\n exclusive_start_id: All requests up to this one (including) are skipped from the result." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 226, - "module": "_models", - "name": "environment_variables", - "parsedDocstring": { - "text": "A map of environment variables to be used during local development and deployment." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 812, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 114 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L812" } ], - "type": { - "name": "Annotated[dict[str, str] | None, Field(alias='environmentVariables')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 657, + "name": "list_requests", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "reference", - "name": "str" + "kind": "text", + "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n\n" } ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 658, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 659, + "name": "exclusive_start_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 660, + "name": "unlock_requests", + "module": "apify_client.clients.resource_clients.request_queue", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The path to the Dockerfile used for building the Actor on the platform." + "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n\nReturns:\n dict: Result of the unlock operation" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 227, - "module": "_models", - "name": "dockerfile", - "parsedDocstring": { - "text": "The path to the Dockerfile used for building the Actor on the platform." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 837, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 118 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L837" } ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The path to the directory used as the Docker context when building the Actor." - } - ] - }, - "flags": {}, - "groups": [], - "id": 228, - "module": "_models", - "name": "docker_context_dir", - "parsedDocstring": { - "text": "The path to the directory used as the Docker context when building the Actor." - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 122 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='dockerContextDir')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + "id": 661, + "name": "unlock_requests", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n\n" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Result of the unlock operation" + } + ] + } + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 603 + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The path to the README file for the Actor." - } - ] - }, - "flags": {}, - "groups": [], - "id": 229, - "module": "_models", - "name": "readme", - "parsedDocstring": { - "text": "The path to the README file for the Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 126 - } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] + "title": "Methods", + "children": [ + 623, + 646, + 653, + 614, + 634, + 642, + 608, + 627, + 619, + 616, + 656, + 637, + 660, + 610, + 630 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/request_queue.py", + "line": 428, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/request_queue.py#L428" + } + ] + }, + { + "id": 662, + "name": "LogClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating logs." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 663, + "name": "get", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The input schema object, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/input-schema)" + "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\nArgs:\n raw: If true, the log will include formatting. For example, coloring character sequences.\n\nReturns:\n The retrieved log, or None, if it does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 230, - "module": "_models", - "name": "input", - "parsedDocstring": { - "text": "The input schema object, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/input-schema)" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 35, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 130 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L35" } ], - "type": { - "name": "dict[str, Any] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 664, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "reference", - "name": "Any" + "kind": "text", + "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n" } ] }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The path to the CHANGELOG file displayed in the Actor's information tab." - } - ] - }, - "flags": {}, - "groups": [], - "id": 231, - "module": "_models", - "name": "changelog", - "parsedDocstring": { - "text": "The path to the CHANGELOG file displayed in the Actor's information tab." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 134 - } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { + "type": { "type": "reference", - "name": "str" + "name": "str | None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 665, + "name": "raw", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "False" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 666, + "name": "get_as_bytes", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\nArgs:\n raw: If true, the log will include formatting. For example, coloring character sequences.\n\nReturns:\n The retrieved log as raw bytes, or None, if it does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 232, - "module": "_models", - "name": "storages", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 60, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 138 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L60" } ], - "type": { - "name": "Storages | None", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 667, + "name": "get_as_bytes", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "Storages", - "target": "1172" + "name": "bytes | None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 668, + "name": "raw", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "False" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 669, + "name": "stream", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Specifies the default amount of memory in megabytes to be used when the Actor is started. Can be an integer or a [dynamic memory expression](/platform/actors/development/actor-definition/dynamic-actor-memory)." + "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\nArgs:\n raw: If true, the log will include formatting. For example, coloring character sequences.\n\nReturns:\n The retrieved log as a context-managed streaming `Response`, or None, if it does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 233, - "module": "_models", - "name": "default_memory_mbytes", - "parsedDocstring": { - "text": "Specifies the default amount of memory in megabytes to be used when the Actor is started. Can be an integer or a [dynamic memory expression](/platform/actors/development/actor-definition/dynamic-actor-memory)." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 86, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 139 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L86" } ], - "type": { - "name": "Annotated[str | int | None, Field(alias='defaultMemoryMbytes')]", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 670, + "name": "stream", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "reference", - "name": "int" + "kind": "text", + "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n" } ] }, - { - "type": "literal", - "value": null - } - ] + "type": { + "type": "reference", + "name": "Iterator[impit.Response | None]" + }, + "parameters": [ + { + "id": 671, + "name": "raw", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "False" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 663, + 666, + 669 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 28, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L28" + } + ] + }, + { + "id": 672, + "name": "LogClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating logs." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 673, + "name": "get", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Specifies the minimum amount of memory in megabytes required by the Actor." + "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\nArgs:\n raw: If true, the log will include formatting. For example, coloring character sequences.\n\nReturns:\n The retrieved log, or None, if it does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 234, - "module": "_models", - "name": "min_memory_mbytes", - "parsedDocstring": { - "text": "Specifies the minimum amount of memory in megabytes required by the Actor." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 122, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 143 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L122" } ], - "type": { - "name": "Annotated[int | None, Field(alias='minMemoryMbytes', ge=256)]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 674, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "int" + "name": "str | None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 675, + "name": "raw", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "False" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 676, + "name": "get_as_bytes", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Specifies the maximum amount of memory in megabytes required by the Actor." + "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\nArgs:\n raw: If true, the log will include formatting. For example, coloring character sequences.\n\nReturns:\n The retrieved log as raw bytes, or None, if it does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 235, - "module": "_models", - "name": "max_memory_mbytes", - "parsedDocstring": { - "text": "Specifies the maximum amount of memory in megabytes required by the Actor." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 147, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 147 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L147" } ], - "type": { - "name": "Annotated[int | None, Field(alias='maxMemoryMbytes', ge=256)]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 677, + "name": "get_as_bytes", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "int" + "name": "bytes | None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 678, + "name": "raw", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "False" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 679, + "name": "stream", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Specifies whether Standby mode is enabled for the Actor." + "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\nArgs:\n raw: If true, the log will include formatting. For example, coloring character sequences.\n\nReturns:\n The retrieved log as a context-managed streaming `Response`, or None, if it does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 236, - "module": "_models", - "name": "uses_standby_mode", - "parsedDocstring": { - "text": "Specifies whether Standby mode is enabled for the Actor." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 173, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 151 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L173" } ], - "type": { - "name": "Annotated[bool | None, Field(alias='usesStandbyMode')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 680, + "name": "stream", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "bool" + "name": "AsyncIterator[impit.Response | None]" }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The definition of the Actor, the full specification of this field can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/actor-json)." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + "parameters": [ + { + "id": 681, + "name": "raw", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "False" + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 222, - 225, - 231, - 233, - 228, - 227, - 226, - 230, - 235, - 234, - 221, - 223, - 229, - 232, - 236, - 224 - ], - "title": "Properties" + 673, + 676, + 679 + ] } ], - "id": 220, - "module": "_models", - "name": "ActorDefinition", - "parsedDocstring": { - "text": "The definition of the Actor, the full specification of this field can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/actor-json)." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 115, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 91 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L115" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 682, + "name": "StreamedLog", + "module": "apify_client.clients.resource_clients.log", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Utility class for streaming logs from another Actor.\n\nIt uses buffer to deal with possibly chunked logs. Chunked logs are stored in buffer. Chunks are expected to contain\nspecific markers that indicate the start of the log message. Each time a new chunk with complete split marker\narrives, the buffer is processed, logged and emptied.\n\nThis works only if the logs have datetime marker in ISO format. For example, `2025-05-12T15:35:59.429Z` This is the\ndefault log standard for the actors." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 683, + "name": "__init__", + "module": "apify_client.clients.resource_clients.log", + "kind": 512, + "kindString": "Constructor", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Initialize `StreamedLog`.\n\nArgs:\n to_logger: The logger to which the logs will be redirected.\n from_start: If `True`, all logs from the start of the actor run will be redirected. If `False`, only newly\n arrived logs will be redirected. This can be useful for redirecting only a small portion of relevant\n logs for long-running actors in stand-by." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 238, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 216, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 161 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L216" } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 239, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 165 + "id": 684, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StreamedLog`.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 685, + "name": "to_logger", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "logging.Logger" + } + }, + { + "id": 686, + "name": "from_start", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "defaultValue": "True" + } + ] } - ], - "type": { - "name": "Actor", - "type": "reference", - "target": "192" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response containing Actor data." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + ] } ], - "flags": {}, "groups": [ { + "title": "Constructors", "children": [ - 239, - 238 - ], - "title": "Properties" + 683 + ] } ], - "id": 237, - "module": "_models", - "name": "ActorResponse", - "parsedDocstring": { - "text": "Response containing Actor data." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 202, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 158 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L202" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 687, + "name": "StreamedLogSync", + "module": "apify_client.clients.resource_clients.log", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sync variant of `StreamedLog` that is logging in threads." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 688, + "name": "start", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Start the streaming thread. The caller has to handle any cleanup by manually calling the `stop` method." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 241, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 290, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 170 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L290" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 689, + "name": "start", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming thread. The caller has to handle any cleanup by manually calling the `stop` method." + } + ] + }, + "type": { + "type": "reference", + "name": "Thread" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 690, + "name": "stop", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Signal the streaming thread to stop logging and wait for it to finish." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 242, - "module": "_models", - "name": "error", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 299, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 174 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L299" } ], - "type": { - "name": "RunFailedErrorDetail | None", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 691, + "name": "stop", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signal the streaming thread to stop logging and wait for it to finish." + } + ] + }, + "type": { "type": "reference", - "name": "RunFailedErrorDetail", - "target": "989" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 242, - 241 - ], - "title": "Properties" - } - ], - "id": 240, - "module": "_models", - "name": "ActorRunFailedError", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 169 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "parameters": [] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 692, + "name": "__enter__", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Start the streaming thread within the context. Exiting the context will finish the streaming thread." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 244, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 308, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 179 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L308" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 693, + "name": "__enter__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming thread within the context. Exiting the context will finish the streaming thread." + } + ] + }, + "type": { + "type": "reference", + "name": "Self" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 694, + "name": "__exit__", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Stop the streaming thread." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 245, - "module": "_models", - "name": "error", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 313, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 183 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L313" } ], - "type": { - "name": "RunTimeoutExceededErrorDetail | None", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 695, + "name": "__exit__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stop the streaming thread." + } + ] + }, + "type": { "type": "reference", - "name": "RunTimeoutExceededErrorDetail", - "target": "1044" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + "parameters": [ + { + "id": 696, + "name": "exc_type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "type[BaseException] | None" + } + }, + { + "id": 697, + "name": "exc_val", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "BaseException | None" + } + }, + { + "id": 698, + "name": "exc_tb", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "TracebackType | None" + } + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 245, - 244 - ], - "title": "Properties" + 692, + 694, + 688, + 690 + ] } ], - "id": 243, - "module": "_models", - "name": "ActorRunTimeoutExceededError", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 281, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 178 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L281" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 699, + "name": "StreamedLogAsync", + "module": "apify_client.clients.resource_clients.log", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async variant of `StreamedLog` that is logging in tasks." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 700, + "name": "start", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Start the streaming task. The caller has to handle any cleanup by manually calling the `stop` method." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 247, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 341, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 188 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L341" } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 248, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 192 + "id": 701, + "name": "start", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming task. The caller has to handle any cleanup by manually calling the `stop` method." + } + ] + }, + "type": { + "type": "reference", + "name": "Task" + }, + "parameters": [] } - ], - "type": { - "name": "str", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 702, + "name": "stop", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Stop the streaming task." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 249, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 348, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 193 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L348" } ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } + "signatures": [ + { + "id": 703, + "name": "stop", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stop the streaming task." + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 704, + "name": "__aenter__", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Start the streaming task within the context. Exiting the context will cancel the streaming task." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 250, - "module": "_models", - "name": "modified_at", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 359, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 194 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L359" } ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } + "signatures": [ + { + "id": 705, + "name": "__aenter__", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming task within the context. Exiting the context will cancel the streaming task." + } + ] + }, + "type": { + "type": "reference", + "name": "Self" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 706, + "name": "__aexit__", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Cancel the streaming task." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 251, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 364, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 195 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L364" } ], - "type": { - "name": "str", - "type": "reference" + "signatures": [ + { + "id": 707, + "name": "__aexit__", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Cancel the streaming task." + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 708, + "name": "exc_type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "type[BaseException] | None" + } + }, + { + "id": 709, + "name": "exc_val", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "BaseException | None" + } + }, + { + "id": 710, + "name": "exc_tb", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "TracebackType | None" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 704, + 706, + 700, + 702 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 333, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L333" + } + ] + }, + { + "id": 711, + "name": "StatusMessageWatcher", + "module": "apify_client.clients.resource_clients.log", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Utility class for logging status messages from another Actor run.\n\nStatus message is logged at fixed time intervals, and there is no guarantee that all messages will be logged,\nespecially in cases of frequent status message changes." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 712, + "name": "__init__", + "module": "apify_client.clients.resource_clients.log", + "kind": 512, + "kindString": "Constructor", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Initialize `StatusMessageWatcher`.\n\nArgs:\n to_logger: The logger to which the status message will be redirected.\n check_period: The period with which the status message will be polled." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 252, - "module": "_models", - "name": "username", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 394, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 196 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L394" } ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 253, - "module": "_models", - "name": "title", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 197 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['Hello World Example'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + "id": 713, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StatusMessageWatcher`.\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 254, - "module": "_models", - "name": "stats", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 198 - } - ], - "type": { - "name": "ActorStats | None", - "type": "union", - "types": [ - { + "type": { "type": "reference", - "name": "ActorStats", - "target": "265" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + "parameters": [ + { + "id": 714, + "name": "to_logger", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "logging.Logger" + } + }, + { + "id": 715, + "name": "check_period", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "timedelta" + }, + "defaultValue": "timedelta(seconds=5)" + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Constructors", "children": [ - 249, - 248, - 247, - 250, - 251, - 254, - 253, - 252 - ], - "title": "Properties" + 712 + ] } ], - "id": 246, - "module": "_models", - "name": "ActorShort", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 381, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 187 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L381" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 716, + "name": "StatusMessageWatcherAsync", + "module": "apify_client.clients.resource_clients.log", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async variant of `StatusMessageWatcher` that is logging in task." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 717, + "name": "__init__", + "module": "apify_client.clients.resource_clients.log", + "kind": 512, + "kindString": "Constructor", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Initialize `StatusMessageWatcherAsync`.\n\nArgs:\n run_client: The client for run that will be used to get a status and message.\n to_logger: The logger to which the status message will be redirected.\n check_period: The period with which the status message will be polled." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 256, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 432, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 203 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L432" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 718, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StatusMessageWatcherAsync`.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 719, + "name": "run_client", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "RunClientAsync", + "id": 468 + } + }, + { + "id": 720, + "name": "to_logger", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "logging.Logger" + } + }, + { + "id": 721, + "name": "check_period", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "timedelta" + }, + "defaultValue": "timedelta(seconds=1)" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 722, + "name": "start", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Start the logging task. The caller has to handle any cleanup by manually calling the `stop` method." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 257, - "module": "_models", - "name": "is_enabled", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 446, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 207 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L446" } ], - "type": { - "name": "Annotated[bool | None, Field(alias='isEnabled')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 723, + "name": "start", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the logging task. The caller has to handle any cleanup by manually calling the `stop` method." + } + ] + }, + "type": { "type": "reference", - "name": "bool" + "name": "Task" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 724, + "name": "stop", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Stop the logging task." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 258, - "module": "_models", - "name": "desired_requests_per_actor_run", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 453, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 208 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L453" } ], - "type": { - "name": "Annotated[int | None, Field(alias='desiredRequestsPerActorRun')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 725, + "name": "stop", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stop the logging task." + } + ] + }, + "type": { "type": "reference", - "name": "int" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 726, + "name": "__aenter__", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Start the logging task within the context. Exiting the context will cancel the logging task." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 259, - "module": "_models", - "name": "max_requests_per_actor_run", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 464, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 209 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L464" } ], - "type": { - "name": "Annotated[int | None, Field(alias='maxRequestsPerActorRun')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 727, + "name": "__aenter__", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the logging task within the context. Exiting the context will cancel the logging task." + } + ] + }, + "type": { "type": "reference", - "name": "int" + "name": "Self" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 728, + "name": "__aexit__", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Cancel the logging task." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 260, - "module": "_models", - "name": "idle_timeout_secs", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 469, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 210 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L469" } ], - "type": { - "name": "Annotated[int | None, Field(alias='idleTimeoutSecs')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 729, + "name": "__aexit__", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Cancel the logging task." + } + ] + }, + "type": { "type": "reference", - "name": "int" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 730, + "name": "exc_type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "type[BaseException] | None" + } + }, + { + "id": 731, + "name": "exc_val", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "BaseException | None" + } + }, + { + "id": 732, + "name": "exc_tb", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "TracebackType | None" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 717 + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "title": "Methods", + "children": [ + 726, + 728, + 722, + 724 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 429, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L429" + } + ] + }, + { + "id": 733, + "name": "StatusMessageWatcherSync", + "module": "apify_client.clients.resource_clients.log", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sync variant of `StatusMessageWatcher` that is logging in thread." + } + ] + }, + "children": [ + { + "id": 734, + "name": "__init__", + "module": "apify_client.clients.resource_clients.log", + "kind": 512, + "kindString": "Constructor", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Initialize `StatusMessageWatcherSync`.\n\nArgs:\n run_client: The client for run that will be used to get a status and message.\n to_logger: The logger to which the status message will be redirected.\n check_period: The period with which the status message will be polled." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 261, - "module": "_models", - "name": "build", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 487, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 211 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L487" } ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 735, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StatusMessageWatcherSync`.\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 736, + "name": "run_client", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "RunClient", + "id": 415 + } + }, + { + "id": 737, + "name": "to_logger", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "logging.Logger" + } + }, + { + "id": 738, + "name": "check_period", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "timedelta" + }, + "defaultValue": "timedelta(seconds=1)" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 739, + "name": "start", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Start the logging thread. The caller has to handle any cleanup by manually calling the `stop` method." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 262, - "module": "_models", - "name": "memory_mbytes", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 502, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 212 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L502" } ], - "type": { - "name": "Annotated[int | None, Field(alias='memoryMbytes')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 740, + "name": "start", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the logging thread. The caller has to handle any cleanup by manually calling the `stop` method." + } + ] + }, + "type": { "type": "reference", - "name": "int" + "name": "Thread" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 741, + "name": "stop", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Signal the _logging_thread thread to stop logging and wait for it to finish." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 263, - "module": "_models", - "name": "disable_standby_fields_override", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 511, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 213 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L511" } ], - "type": { - "name": "Annotated[bool | None, Field(alias='disableStandbyFieldsOverride')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], + "signatures": [ + { + "id": 742, + "name": "stop", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signal the _logging_thread thread to stop logging and wait for it to finish." + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + }, + { + "id": 743, + "name": "__enter__", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Start the logging task within the context. Exiting the context will cancel the logging task." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 264, - "module": "_models", - "name": "should_pass_actor_input", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 521, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 214 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L521" } ], - "type": { - "name": "Annotated[bool | None, Field(alias='shouldPassActorInput')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 744, + "name": "__enter__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the logging task within the context. Exiting the context will cancel the logging task." + } + ] + }, + "type": { "type": "reference", - "name": "bool" + "name": "Self" }, + "parameters": [] + } + ] + }, + { + "id": 745, + "name": "__exit__", + "module": "apify_client.clients.resource_clients.log", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Cancel the logging task." } ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 526, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L526" + } + ], + "signatures": [ + { + "id": 746, + "name": "__exit__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Cancel the logging task." + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 747, + "name": "exc_type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "type[BaseException] | None" + } + }, + { + "id": 748, + "name": "exc_val", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "BaseException | None" + } + }, + { + "id": 749, + "name": "exc_tb", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "TracebackType | None" + } + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Constructors", "children": [ - 261, - 258, - 263, - 260, - 257, - 259, - 262, - 256, - 264 - ], - "title": "Properties" + 734 + ] + }, + { + "title": "Methods", + "children": [ + 743, + 745, + 739, + 741 + ] } ], - "id": 255, - "module": "_models", - "name": "ActorStandby", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/log.py", + "line": 484, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 202 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/log.py#L484" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 750, + "name": "KeyValueStoreCollectionClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating key-value stores." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 751, + "name": "list", + "module": "apify_client.clients.resource_clients.key_value_store_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n\nArgs:\n unnamed: Whether to include unnamed key-value stores in the list.\n limit: How many key-value stores to retrieve.\n offset: What key-value store to include as first when retrieving the list.\n desc: Whether to sort the key-value stores in descending order based on their modification date.\n\nReturns:\n The list of available key-value stores matching the specified filters." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 266, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store_collection.py", + "line": 19, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 219 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store_collection.py#L19" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 752, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 753, + "name": "unnamed", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 754, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 755, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 756, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 757, + "name": "get_or_create", + "module": "apify_client.clients.resource_clients.key_value_store_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n\nArgs:\n name: The name of the key-value store to retrieve or create.\n schema: The schema of the key-value store.\n\nReturns:\n The retrieved or newly-created key-value store." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 267, - "module": "_models", - "name": "total_builds", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store_collection.py", + "line": 42, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 223 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store_collection.py#L42" } ], - "type": { - "name": "Annotated[int | None, Field(alias='totalBuilds', examples=[9])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" + "signatures": [ + { + "id": 758, + "name": "get_or_create", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 759, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 760, + "name": "schema", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 757, + 751 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store_collection.py", + "line": 12, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store_collection.py#L12" + } + ] + }, + { + "id": 761, + "name": "KeyValueStoreCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating key-value stores." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 762, + "name": "list", + "module": "apify_client.clients.resource_clients.key_value_store_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n\nArgs:\n unnamed: Whether to include unnamed key-value stores in the list.\n limit: How many key-value stores to retrieve.\n offset: What key-value store to include as first when retrieving the list.\n desc: Whether to sort the key-value stores in descending order based on their modification date.\n\nReturns:\n The list of available key-value stores matching the specified filters." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 268, - "module": "_models", - "name": "total_runs", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store_collection.py", + "line": 69, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 224 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store_collection.py#L69" } ], - "type": { - "name": "Annotated[int | None, Field(alias='totalRuns', examples=[16])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 763, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "int" + "name": "ListPage[dict]" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 764, + "name": "unnamed", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 765, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 766, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 767, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 768, + "name": "get_or_create", + "module": "apify_client.clients.resource_clients.key_value_store_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n\nArgs:\n name: The name of the key-value store to retrieve or create.\n schema: The schema of the key-value store.\n\nReturns:\n The retrieved or newly-created key-value store." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 269, - "module": "_models", - "name": "total_users", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store_collection.py", + "line": 92, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 225 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store_collection.py#L92" } ], - "type": { - "name": "Annotated[int | None, Field(alias='totalUsers', examples=[6])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" + "signatures": [ + { + "id": 769, + "name": "get_or_create", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 770, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 771, + "name": "schema", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 768, + 762 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store_collection.py", + "line": 62, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store_collection.py#L62" + } + ] + }, + { + "id": 772, + "name": "KeyValueStoreClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single key-value store." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 773, + "name": "get", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n\nReturns:\n The retrieved key-value store, or None if it does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 270, - "module": "_models", - "name": "total_users7_days", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 37, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 226 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L37" } ], - "type": { - "name": "Annotated[int | None, Field(alias='totalUsers7Days', examples=[2])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 774, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "int" + "name": "dict | None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 775, + "name": "update", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n\nArgs:\n name: The new name for key-value store.\n general_access: Determines how others can access the key-value store.\n\nReturns:\n The updated key-value store." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 271, - "module": "_models", - "name": "total_users30_days", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 47, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 227 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L47" } ], - "type": { - "name": "Annotated[int | None, Field(alias='totalUsers30Days', examples=[6])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" + "signatures": [ + { + "id": 776, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 777, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 778, + "name": "general_access", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "StorageGeneralAccess | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 779, + "name": "delete", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 272, - "module": "_models", - "name": "total_users90_days", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 66, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 228 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L66" } ], - "type": { - "name": "Annotated[int | None, Field(alias='totalUsers90Days', examples=[6])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 780, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store" + } + ] + }, + "type": { "type": "reference", - "name": "int" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 781, + "name": "list_keys", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n\nArgs:\n limit: Number of keys to be returned. Maximum value is 1000.\n exclusive_start_key: All keys up to this one (including) are skipped from the result.\n collection: The name of the collection in store schema to list keys from.\n prefix: The prefix of the keys to be listed.\n signature: Signature used to access the items.\n\nReturns:\n The list of keys in the key-value store matching the given arguments." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 273, - "module": "_models", - "name": "total_metamorphs", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 73, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 229 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L73" } ], - "type": { - "name": "Annotated[int | None, Field(alias='totalMetamorphs', examples=[2])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" + "signatures": [ + { + "id": 782, + "name": "list_keys", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 783, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 784, + "name": "exclusive_start_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 785, + "name": "collection", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 786, + "name": "prefix", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 787, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 788, + "name": "get_record", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\nArgs:\n key: Key of the record to retrieve.\n signature: Signature used to access the items.\n\nReturns:\n The requested record, or None, if the record does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 274, - "module": "_models", - "name": "last_run_started_at", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 113, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 230 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L113" } ], - "type": { - "name": "Annotated[ AwareDatetime | None, Field(alias='lastRunStartedAt', examples=['2019-07-08T14:01:05.546Z']) ]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 789, + "name": "get_record", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "AwareDatetime" + "name": "dict | None" }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 274, - 266, - 267, - 273, - 268, - 269, - 271, - 270, - 272 - ], - "title": "Properties" - } - ], - "id": 265, - "module": "_models", - "name": "ActorStats", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 218 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "parameters": [ + { + "id": 790, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 791, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 792, + "name": "record_exists", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n\nArgs:\n key: Key of the record to check.\n\nReturns:\n True if the record exists, False otherwise." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 276, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 143, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 239 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L143" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 793, + "name": "record_exists", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "parameters": [ + { + "id": 794, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 795, + "name": "get_record_as_bytes", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\nArgs:\n key: Key of the record to retrieve.\n signature: Signature used to access the items.\n\nReturns:\n The requested record, or None, if the record does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 277, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 168, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 243 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L168" } ], - "type": { - "name": "RequestRegistration", - "type": "reference", - "target": "948" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response containing the result of adding a request to the request queue." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 277, - 276 - ], - "title": "Properties" - } - ], - "id": 275, - "module": "_models", - "name": "AddRequestResponse", - "parsedDocstring": { - "text": "Response containing the result of adding a request to the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 236 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 279, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 250 + "id": 796, + "name": "get_record_as_bytes", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 797, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 798, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 799, + "name": "stream_record", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique identifier assigned to the request." + "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\nArgs:\n key: Key of the record to retrieve.\n signature: Signature used to access the items.\n\nReturns:\n The requested record as a context-managed streaming Response, or None, if the record does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 280, - "module": "_models", - "name": "request_id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 199, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 254 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L199" } ], - "type": { - "name": "str", - "type": "reference" - } + "signatures": [ + { + "id": 800, + "name": "stream_record", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "Iterator[dict | None]" + }, + "parameters": [ + { + "id": 801, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 802, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 803, + "name": "set_record", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n\nArgs:\n key: The key of the record to save the value to.\n value: The value to save into the record.\n content_type: The content type of the saved value." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 281, - "module": "_models", - "name": "unique_key", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 233, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 258 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L233" } ], - "type": { - "name": "str", - "type": "reference" - } + "signatures": [ + { + "id": 804, + "name": "set_record", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 805, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 806, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + } + }, + { + "id": 807, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 808, + "name": "delete_record", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Indicates whether a request with the same unique key already existed in the request queue. If true, no new request was created." + "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n\nArgs:\n key: The key of the record which to delete." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 282, - "module": "_models", - "name": "was_already_present", - "parsedDocstring": { - "text": "Indicates whether a request with the same unique key already existed in the request queue. If true, no new request was created." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 260, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 262 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L260" } ], - "type": { - "name": "bool", - "type": "reference" - } + "signatures": [ + { + "id": 809, + "name": "delete_record", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 810, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 811, + "name": "get_record_public_url", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Indicates whether a request with the same unique key has already been processed by the request queue." + "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n\nArgs:\n key: The key for which the URL should be generated.\n\nReturns:\n A public URL that can be used to access the value of the given key in the KVS." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 283, - "module": "_models", - "name": "was_already_handled", - "parsedDocstring": { - "text": "Indicates whether a request with the same unique key has already been processed by the request queue." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 275, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 266 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L275" } ], - "type": { - "name": "bool", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Information about a request that was successfully added to a request queue." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 279, - 280, - 281, - 283, - 282 - ], - "title": "Properties" - } - ], - "id": 278, - "module": "_models", - "name": "AddedRequest", - "parsedDocstring": { - "text": "Information about a request that was successfully added to a request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 247 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 285, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 276 + "id": 812, + "name": "get_record_public_url", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 813, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 814, + "name": "create_keys_public_url", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in_secs` option.\nThis value sets the expiration duration in seconds from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n\nReturns:\n The public key-value store keys URL." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 286, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 305, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 280 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L305" } ], - "type": { - "name": "BatchAddResult", - "type": "reference", - "target": "287" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response containing the result of a batch add operation." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + "signatures": [ + { + "id": 815, + "name": "create_keys_public_url", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in_secs` option.\nThis value sets the expiration duration in seconds from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 816, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 817, + "name": "exclusive_start_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 818, + "name": "collection", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 819, + "name": "prefix", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 820, + "name": "expires_in_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 286, - 285 - ], - "title": "Properties" + 814, + 779, + 808, + 773, + 788, + 795, + 811, + 781, + 792, + 803, + 799, + 775 + ] } ], - "id": 284, - "module": "_models", - "name": "BatchAddResponse", - "parsedDocstring": { - "text": "Response containing the result of a batch add operation." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 30, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 273 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L30" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 821, + "name": "KeyValueStoreClientAsync", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single key-value store." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 822, + "name": "get", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n\nReturns:\n The retrieved key-value store, or None if it does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 288, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 361, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 287 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L361" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 823, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 824, + "name": "update", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Requests that were successfully added to the request queue." + "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n\nArgs:\n name: The new name for key-value store.\n general_access: Determines how others can access the key-value store.\n\nReturns:\n The updated key-value store." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 289, - "module": "_models", - "name": "processed_requests", - "parsedDocstring": { - "text": "Requests that were successfully added to the request queue." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 371, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 291 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L371" } ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "AddedRequest", - "target": "278" - } - ], - "target": "2199" - } + "signatures": [ + { + "id": 825, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 826, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 827, + "name": "general_access", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "StorageGeneralAccess | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 828, + "name": "delete", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Requests that failed to be added and can be retried." + "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 290, - "module": "_models", - "name": "unprocessed_requests", - "parsedDocstring": { - "text": "Requests that failed to be added and can be retried." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 390, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 295 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L390" } ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { + "signatures": [ + { + "id": 829, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store" + } + ] + }, + "type": { "type": "reference", - "name": "RequestDraft", - "target": "879" - } - ], - "target": "2199" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Result of a batch add operation containing successfully processed and failed requests." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 288, - 289, - 290 - ], - "title": "Properties" - } - ], - "id": 287, - "module": "_models", - "name": "BatchAddResult", - "parsedDocstring": { - "text": "Result of a batch add operation containing successfully processed and failed requests." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 284 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "name": "None" + }, + "parameters": [] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 830, + "name": "list_keys", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n\nArgs:\n limit: Number of keys to be returned. Maximum value is 1000.\n exclusive_start_key: All keys up to this one (including) are skipped from the result.\n collection: The name of the collection in store schema to list keys from.\n prefix: The prefix of the keys to be listed.\n signature: Signature used to access the items.\n\nReturns:\n The list of keys in the key-value store matching the given arguments." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 292, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 397, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 305 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L397" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 831, + "name": "list_keys", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 832, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 833, + "name": "exclusive_start_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 834, + "name": "collection", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 835, + "name": "prefix", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 836, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 837, + "name": "get_record", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\nArgs:\n key: Key of the record to retrieve.\n signature: Signature used to access the items.\n\nReturns:\n The requested record, or None, if the record does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 293, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 437, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 309 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L437" } ], - "type": { - "name": "BatchDeleteResult", - "type": "reference", - "target": "294" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response containing the result of a batch delete operation." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 293, - 292 - ], - "title": "Properties" - } - ], - "id": 291, - "module": "_models", - "name": "BatchDeleteResponse", - "parsedDocstring": { - "text": "Response containing the result of a batch delete operation." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 302 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ + { + "id": 838, + "name": "get_record", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 839, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 840, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 841, + "name": "record_exists", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n\nArgs:\n key: Key of the record to check.\n\nReturns:\n True if the record exists, False otherwise." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 295, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 467, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 316 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L467" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 842, + "name": "record_exists", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "parameters": [ + { + "id": 843, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 844, + "name": "get_record_as_bytes", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Requests that were successfully deleted from the request queue." + "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\nArgs:\n key: Key of the record to retrieve.\n signature: Signature used to access the items.\n\nReturns:\n The requested record, or None, if the record does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 296, - "module": "_models", - "name": "processed_requests", - "parsedDocstring": { - "text": "Requests that were successfully deleted from the request queue." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 492, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 320 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L492" } ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "DeletedRequestById", - "target": "507" - }, + "signatures": [ + { + "id": 845, + "name": "get_record_as_bytes", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "reference", - "name": "DeletedRequestByUniqueKey", - "target": "511" + "kind": "text", + "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\n" } ] - } - ], - "target": "2199" - } + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 846, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 847, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 848, + "name": "stream_record", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Requests that failed to be deleted and can be retried." + "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\nArgs:\n key: Key of the record to retrieve.\n signature: Signature used to access the items.\n\nReturns:\n The requested record as a context-managed streaming Response, or None, if the record does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 297, - "module": "_models", - "name": "unprocessed_requests", - "parsedDocstring": { - "text": "Requests that failed to be deleted and can be retried." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 523, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 326 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L523" } ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { + "signatures": [ + { + "id": 849, + "name": "stream_record", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "RequestDraft", - "target": "879" - } - ], - "target": "2199" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Result of a batch delete operation containing successfully deleted and failed requests." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 295, - 296, - 297 - ], - "title": "Properties" - } - ], - "id": 294, - "module": "_models", - "name": "BatchDeleteResult", - "parsedDocstring": { - "text": "Result of a batch delete operation containing successfully deleted and failed requests." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 313 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "name": "AsyncIterator[dict | None]" + }, + "parameters": [ + { + "id": 850, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 851, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 852, + "name": "set_record", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n\nArgs:\n key: The key of the record to save the value to.\n value: The value to save into the record.\n content_type: The content type of the saved value." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 299, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 557, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 334 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L557" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 853, + "name": "set_record", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 854, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 855, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + } + }, + { + "id": 856, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 857, + "name": "delete_record", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "HTTP method of the request." + "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n\nArgs:\n key: The key of the record which to delete." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 300, - "module": "_models", - "name": "method", - "parsedDocstring": { - "text": "HTTP method of the request." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 584, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 338 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L584" } ], - "type": { - "name": "str", - "type": "reference" - } + "signatures": [ + { + "id": 858, + "name": "delete_record", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 859, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 860, + "name": "get_record_public_url", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "IP address of the client." + "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n\nArgs:\n key: The key for which the URL should be generated.\n\nReturns:\n A public URL that can be used to access the value of the given key in the KVS." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 301, - "module": "_models", - "name": "client_ip", - "parsedDocstring": { - "text": "IP address of the client." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 599, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 342 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L599" } ], - "type": { - "name": "Annotated[str | None, Field(alias='clientIp', examples=['1.2.3.4'])]", - "type": "union", - "types": [ - { - "type": "reference", + "signatures": [ + { + "id": 861, + "name": "get_record_public_url", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n\n" + } + ] + }, + "type": { + "type": "intrinsic", "name": "str" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 862, + "name": "key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 863, + "name": "create_keys_public_url", + "module": "apify_client.clients.resource_clients.key_value_store", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Two-letter country code resolved from the client IP address." + "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in_secs` option.\nThis value sets the expiration duration in seconds from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n\nReturns:\n The public key-value store keys URL." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 302, - "module": "_models", - "name": "country_code", - "parsedDocstring": { - "text": "Two-letter country code resolved from the client IP address." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 629, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 346 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L629" } ], - "type": { - "name": "Annotated[str | None, Field(alias='countryCode', examples=['US'])]", - "type": "union", - "types": [ - { - "type": "reference", + "signatures": [ + { + "id": 864, + "name": "create_keys_public_url", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in_secs` option.\nThis value sets the expiration duration in seconds from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n\n" + } + ] + }, + "type": { + "type": "intrinsic", "name": "str" }, - { - "type": "literal", - "value": null - } - ] + "parameters": [ + { + "id": 865, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 866, + "name": "exclusive_start_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 867, + "name": "collection", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 868, + "name": "prefix", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 869, + "name": "expires_in_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 863, + 828, + 857, + 822, + 837, + 844, + 860, + 830, + 841, + 852, + 848, + 824 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/key_value_store.py", + "line": 354, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/key_value_store.py#L354" + } + ] + }, + { + "id": 870, + "name": "DatasetCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating datasets." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 871, + "name": "list", + "module": "apify_client.clients.resource_clients.dataset_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Length of the request body in bytes." + "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n\nArgs:\n unnamed: Whether to include unnamed datasets in the list.\n limit: How many datasets to retrieve.\n offset: What dataset to include as first when retrieving the list.\n desc: Whether to sort the datasets in descending order based on their modification date.\n\nReturns:\n The list of available datasets matching the specified filters." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 303, - "module": "_models", - "name": "body_length", - "parsedDocstring": { - "text": "Length of the request body in bytes." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset_collection.py", + "line": 19, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 350 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset_collection.py#L19" } ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request headers. Omitted when `skipHeaders=true`." - } - ] - }, - "flags": {}, - "groups": [], - "id": 304, - "module": "_models", - "name": "headers", - "parsedDocstring": { - "text": "Request headers. Omitted when `skipHeaders=true`." - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 354 - } - ], - "type": { - "name": "dict[str, str | list[str]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, + "id": 872, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - } - ] + "kind": "text", + "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n\n" } ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 873, + "name": "unnamed", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 874, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 875, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 876, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 877, + "name": "get_or_create", + "module": "apify_client.clients.resource_clients.dataset_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Raw request headers as a flat list of alternating name/value strings.\nIncluded only when `rawHeaders=true`." + "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n\nArgs:\n name: The name of the dataset to retrieve or create.\n schema: The schema of the dataset.\n\nReturns:\n The retrieved or newly-created dataset." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 305, - "module": "_models", - "name": "raw_headers", - "parsedDocstring": { - "text": "Raw request headers as a flat list of alternating name/value strings.\nIncluded only when `rawHeaders=true`." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset_collection.py", + "line": 42, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 359 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset_collection.py#L42" } ], - "type": { - "name": "Annotated[list[str] | None, Field(alias='rawHeaders')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ + "signatures": [ + { + "id": 878, + "name": "get_or_create", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "reference", - "name": "str" + "kind": "text", + "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n\n" } - ], - "target": "2199" + ] }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 879, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 880, + "name": "schema", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 303, - 301, - 302, - 304, - 300, - 299, - 305 - ], - "title": "Properties" + 877, + 871 + ] } ], - "id": 298, - "module": "_models", - "name": "BrowserInfoResponse", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset_collection.py", + "line": 12, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 333 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset_collection.py#L12" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 881, + "name": "DatasetCollectionClientAsync", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating datasets." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 882, + "name": "list", + "module": "apify_client.clients.resource_clients.dataset_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n\nArgs:\n unnamed: Whether to include unnamed datasets in the list.\n limit: How many datasets to retrieve.\n offset: What dataset to include as first when retrieving the list.\n desc: Whether to sort the datasets in descending order based on their modification date.\n\nReturns:\n The list of available datasets matching the specified filters." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 307, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset_collection.py", + "line": 64, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 369 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset_collection.py#L64" } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 308, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 373 + "id": 883, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 884, + "name": "unnamed", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 885, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 886, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 887, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "str", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 888, + "name": "get_or_create", + "module": "apify_client.clients.resource_clients.dataset_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n\nArgs:\n name: The name of the dataset to retrieve or create.\n schema: The schema of the dataset.\n\nReturns:\n The retrieved or newly-created dataset." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 309, - "module": "_models", - "name": "act_id", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset_collection.py", + "line": 87, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 374 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset_collection.py#L87" } ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 310, - "module": "_models", - "name": "user_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 375 + "id": 889, + "name": "get_or_create", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 890, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 891, + "name": "schema", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "str", - "type": "reference" + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 888, + 882 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/dataset_collection.py", + "line": 57, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset_collection.py#L57" + } + ] + }, + { + "id": 892, + "name": "DatasetClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single dataset." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 893, + "name": "get", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n\nReturns:\n The retrieved dataset, or None, if it does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 311, - "module": "_models", - "name": "started_at", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 38, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 376 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L38" } ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } + "signatures": [ + { + "id": 894, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 895, + "name": "update", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n\nArgs:\n name: The new name for the dataset.\n general_access: Determines how others can access the dataset.\n\nReturns:\n The updated dataset." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 312, - "module": "_models", - "name": "finished_at", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 48, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 377 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L48" } ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" + "signatures": [ + { + "id": 896, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 897, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 898, + "name": "general_access", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "StorageGeneralAccess | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 899, + "name": "delete", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 313, - "module": "_models", - "name": "status", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 67, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 380 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L67" } ], - "type": { - "name": "ActorJobStatus", - "type": "reference", - "target": "1794" - } + "signatures": [ + { + "id": 900, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 901, + "name": "list_items", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\nArgs:\n offset: Number of items that should be skipped at the start. The default value is 0.\n limit: Maximum number of items to return. By default there is no limit.\n desc: By default, results are returned in the same order as they were stored. To reverse the order,\n set this parameter to True.\n clean: If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\n the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\n parameters. Note that since some objects might be skipped from the output, that the result might\n contain less items than the limit value.\n fields: A list of fields which should be picked from the items, only these fields will remain\n in the resulting record objects. Note that the fields in the outputted items are sorted the same\n way as they are specified in the fields parameter. You can use this feature to effectively fix\n the output format.\n omit: A list of fields which should be omitted from the items.\n unwind: A list of fields which should be unwound, in order which they should be processed. Each field\n should be either an array or an object. If the field is an array then every element of the array\n will become a separate record and merged with parent object. If the unwound field is an object then\n it is merged with the parent object. If the unwound field is missing or its value is neither an array\n nor an object and therefore cannot be merged with a parent object, then the item gets preserved\n as it is. Note that the unwound items ignore the desc parameter.\n skip_empty: If True, then empty items are skipped from the output. Note that if used, the results might\n contain less items than the limit value.\n skip_hidden: If True, then hidden fields are skipped from the output, i.e. fields starting with\n the # character.\n flatten: A list of fields that should be flattened.\n view: Name of the dataset view to be used.\n signature: Signature used to access the items.\n\nReturns:\n A page of the list of dataset items according to the specified filters." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 314, - "module": "_models", - "name": "meta", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 74, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 381 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L74" } ], - "type": { - "name": "BuildsMeta", - "type": "reference", - "target": "353" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 315, - "module": "_models", - "name": "stats", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 382 - } - ], - "type": { - "name": "BuildStats | None", - "type": "union", - "types": [ - { + "id": 902, + "name": "list_items", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "BuildStats", - "target": "342" + "name": "ListPage", + "id": 1725 }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 903, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 904, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 905, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 906, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 907, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 908, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 909, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 910, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 911, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 912, + "name": "flatten", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 913, + "name": "view", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 914, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 915, + "name": "iterate_items", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Iterate over the items in the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\nArgs:\n offset: Number of items that should be skipped at the start. The default value is 0.\n limit: Maximum number of items to return. By default there is no limit.\n desc: By default, results are returned in the same order as they were stored. To reverse the order,\n set this parameter to True.\n clean: If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\n the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\n parameters. Note that since some objects might be skipped from the output, that the result might\n contain less items than the limit value.\n fields: A list of fields which should be picked from the items, only these fields will remain in\n the resulting record objects. Note that the fields in the outputted items are sorted the same way\n as they are specified in the fields parameter. You can use this feature to effectively fix\n the output format.\n omit: A list of fields which should be omitted from the items.\n unwind: A list of fields which should be unwound, in order which they should be processed. Each field\n should be either an array or an object. If the field is an array then every element of the array\n will become a separate record and merged with parent object. If the unwound field is an object then\n it is merged with the parent object. If the unwound field is missing or its value is neither an array\n nor an object and therefore cannot be merged with a parent object, then the item gets preserved\n as it is. Note that the unwound items ignore the desc parameter.\n skip_empty: If True, then empty items are skipped from the output. Note that if used, the results might\n contain less items than the limit value.\n skip_hidden: If True, then hidden fields are skipped from the output, i.e. fields starting with\n the # character.\n signature: Signature used to access the items.\n\nYields:\n An item from the dataset." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 316, - "module": "_models", - "name": "options", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 163, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 383 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L163" } ], - "type": { - "name": "BuildOptions | None", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 916, + "name": "iterate_items", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the items in the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "BuildOptions", - "target": "324" + "name": "Iterator[dict]" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 917, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "defaultValue": "0" + }, + { + "id": 918, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 919, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 920, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 921, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 922, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 923, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 924, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 925, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 926, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 927, + "name": "download_items", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get the items in the dataset as raw bytes.\n\nDeprecated: this function is a deprecated alias of `get_items_as_bytes`. It will be removed in\na future version.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\nArgs:\n item_format: Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\n The default value is json.\n offset: Number of items that should be skipped at the start. The default value is 0.\n limit: Maximum number of items to return. By default there is no limit.\n desc: By default, results are returned in the same order as they were stored. To reverse the order,\n set this parameter to True.\n clean: If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\n the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\n parameters. Note that since some objects might be skipped from the output, that the result might\n contain less items than the limit value.\n bom: All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\n the UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\n to override this default behavior, specify bom=True query parameter to include the BOM or bom=False\n to skip it.\n delimiter: A delimiter character for CSV files. The default delimiter is a simple comma (,).\n fields: A list of fields which should be picked from the items, only these fields will remain in\n the resulting record objects. Note that the fields in the outputted items are sorted the same way\n as they are specified in the fields parameter. You can use this feature to effectively fix the\n output format.\n omit: A list of fields which should be omitted from the items.\n unwind: A list of fields which should be unwound, in order which they should be processed. Each field\n should be either an array or an object. If the field is an array then every element of the array\n will become a separate record and merged with parent object. If the unwound field is an object then\n it is merged with the parent object. If the unwound field is missing or its value is neither an array\n nor an object and therefore cannot be merged with a parent object, then the item gets preserved\n as it is. Note that the unwound items ignore the desc parameter.\n skip_empty: If True, then empty items are skipped from the output. Note that if used, the results might\n contain less items than the limit value.\n skip_header_row: If True, then header row in the csv format is skipped.\n skip_hidden: If True, then hidden fields are skipped from the output, i.e. fields starting with\n the # character.\n xml_root: Overrides default root element name of xml output. By default the root element is items.\n xml_row: Overrides default element name that wraps each page or page function result object in xml output.\n By default the element name is item.\n flatten: A list of fields that should be flattened.\n signature: Signature used to access the items.\n\nReturns:\n The dataset items as raw bytes." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 317, - "module": "_models", - "name": "usage", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 246, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 384 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L246" } ], - "type": { - "name": "BuildUsage | None", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 928, + "name": "download_items", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the items in the dataset as raw bytes.\n\nDeprecated: this function is a deprecated alias of `get_items_as_bytes`. It will be removed in\na future version.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "BuildUsage", - "target": "350" + "name": "bytes" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 929, + "name": "item_format", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "defaultValue": "'json'" + }, + { + "id": 930, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 931, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 932, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 933, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 934, + "name": "bom", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 935, + "name": "delimiter", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 936, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 937, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 938, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 939, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 940, + "name": "skip_header_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 941, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 942, + "name": "xml_root", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 943, + "name": "xml_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 944, + "name": "flatten", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 945, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 946, + "name": "get_items_as_bytes", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Total cost in USD for this build. Requires authentication token to access." + "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\nArgs:\n item_format: Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\n The default value is json.\n offset: Number of items that should be skipped at the start. The default value is 0.\n limit: Maximum number of items to return. By default there is no limit.\n desc: By default, results are returned in the same order as they were stored. To reverse the order,\n set this parameter to True.\n clean: If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\n the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\n parameters. Note that since some objects might be skipped from the output, that the result might\n contain less items than the limit value.\n bom: All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\n the UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\n to override this default behavior, specify bom=True query parameter to include the BOM or bom=False\n to skip it.\n delimiter: A delimiter character for CSV files. The default delimiter is a simple comma (,).\n fields: A list of fields which should be picked from the items, only these fields will remain\n in the resulting record objects. Note that the fields in the outputted items are sorted the same\n way as they are specified in the fields parameter. You can use this feature to effectively fix\n the output format.\n You can use this feature to effectively fix the output format.\n omit: A list of fields which should be omitted from the items.\n unwind: A list of fields which should be unwound, in order which they should be processed. Each field\n should be either an array or an object. If the field is an array then every element of the array\n will become a separate record and merged with parent object. If the unwound field is an object then\n it is merged with the parent object. If the unwound field is missing or its value is neither an array\n nor an object and therefore cannot be merged with a parent object, then the item gets preserved\n as it is. Note that the unwound items ignore the desc parameter.\n skip_empty: If True, then empty items are skipped from the output. Note that if used, the results might\n contain less items than the limit value.\n skip_header_row: If True, then header row in the csv format is skipped.\n skip_hidden: If True, then hidden fields are skipped from the output, i.e. fields starting with\n the # character.\n xml_root: Overrides default root element name of xml output. By default the root element is items.\n xml_row: Overrides default element name that wraps each page or page function result object in xml output.\n By default the element name is item.\n flatten: A list of fields that should be flattened.\n signature: Signature used to access the items.\n\nReturns:\n The dataset items as raw bytes." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 318, - "module": "_models", - "name": "usage_total_usd", - "parsedDocstring": { - "text": "Total cost in USD for this build. Requires authentication token to access." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 341, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 385 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L341" } ], - "type": { - "name": "Annotated[float | None, Field(alias='usageTotalUsd', examples=[0.02])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Platform usage costs breakdown in USD for this build. Requires authentication token to access." - } - ] - }, - "flags": {}, - "groups": [], - "id": 319, - "module": "_models", - "name": "usage_usd", - "parsedDocstring": { - "text": "Platform usage costs breakdown in USD for this build. Requires authentication token to access." - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 389 - } - ], - "type": { - "name": "Annotated[BuildUsage | None, Field(alias='usageUsd')]", - "type": "union", - "types": [ - { + "id": 947, + "name": "get_items_as_bytes", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "BuildUsage", - "target": "350" + "name": "bytes" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 948, + "name": "item_format", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "defaultValue": "'json'" + }, + { + "id": 949, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 950, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 951, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 952, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 953, + "name": "bom", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 954, + "name": "delimiter", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 955, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 956, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 957, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 958, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 959, + "name": "skip_header_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 960, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 961, + "name": "xml_root", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 962, + "name": "xml_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 963, + "name": "flatten", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 964, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 965, + "name": "stream_items", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\nArgs:\n item_format: Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\n The default value is json.\n offset: Number of items that should be skipped at the start. The default value is 0.\n limit: Maximum number of items to return. By default there is no limit.\n desc: By default, results are returned in the same order as they were stored. To reverse the order,\n set this parameter to True.\n clean: If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\n the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\n parameters. Note that since some objects might be skipped from the output, that the result might\n contain less items than the limit value.\n bom: All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\n the UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\n to override this default behavior, specify bom=True query parameter to include the BOM or bom=False\n to skip it.\n delimiter: A delimiter character for CSV files. The default delimiter is a simple comma (,).\n fields: A list of fields which should be picked from the items, only these fields will remain\n in the resulting record objects. Note that the fields in the outputted items are sorted the same\n way as they are specified in the fields parameter. You can use this feature to effectively fix\n the output format.\n You can use this feature to effectively fix the output format.\n omit: A list of fields which should be omitted from the items.\n unwind: A list of fields which should be unwound, in order which they should be processed. Each field\n should be either an array or an object. If the field is an array then every element of the array\n will become a separate record and merged with parent object. If the unwound field is an object then\n it is merged with the parent object. If the unwound field is missing or its value is neither an array\n nor an object and therefore cannot be merged with a parent object, then the item gets preserved\n as it is. Note that the unwound items ignore the desc parameter.\n skip_empty: If True, then empty items are skipped from the output. Note that if used, the results might\n contain less items than the limit value.\n skip_header_row: If True, then header row in the csv format is skipped.\n skip_hidden: If True, then hidden fields are skipped from the output, i.e. fields starting with\n the # character.\n xml_root: Overrides default root element name of xml output. By default the root element is items.\n xml_row: Overrides default element name that wraps each page or page function result object in xml output.\n By default the element name is item.\n signature: Signature used to access the items.\n\nReturns:\n The dataset items as a context-managed streaming `Response`." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 320, - "module": "_models", - "name": "input_schema", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 437, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 393 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L437" } ], - "type": { - "name": "Annotated[ str | None, Field(alias='inputSchema', deprecated=True, examples=['{\\\\n \"title\": \"Schema for ... }']) ]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 966, + "name": "stream_items", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "Iterator[impit.Response]" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 967, + "name": "item_format", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "defaultValue": "'json'" + }, + { + "id": 968, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 969, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 970, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 971, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 972, + "name": "bom", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 973, + "name": "delimiter", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 974, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 975, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 976, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 977, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 978, + "name": "skip_header_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 979, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 980, + "name": "xml_root", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 981, + "name": "xml_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 982, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 983, + "name": "push_items", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n\nArgs:\n items: The items which to push in the dataset. Either a stringified JSON, a dictionary, or a list\n of strings or dictionaries." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 321, - "module": "_models", - "name": "readme", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 534, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 396 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L534" } ], - "type": { - "name": "Annotated[str | None, Field(deprecated=True, examples=['", - "type": "reference" - } + "signatures": [ + { + "id": 984, + "name": "push_items", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 985, + "name": "items", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "JSONSerializable", + "id": 1724 + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 986, + "name": "get_statistics", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n\nReturns:\n The dataset statistics or None if the dataset does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 322, - "module": "_models", - "name": "build_number", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 561, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 397 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L561" } ], - "type": { - "name": "str", - "type": "reference" - } + "signatures": [ + { + "id": 987, + "name": "get_statistics", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 988, + "name": "create_items_public_url", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in_secs` option.\nThis value sets the expiration duration in seconds from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n\nReturns:\n The public dataset items URL." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 323, - "module": "_models", - "name": "actor_definition", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 582, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 398 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L582" } ], - "type": { - "name": "Annotated[ActorDefinition | None, Field(alias='actorDefinition')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorDefinition", - "target": "220" + "signatures": [ + { + "id": 989, + "name": "create_items_public_url", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in_secs` option.\nThis value sets the expiration duration in seconds from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 990, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 991, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 992, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 993, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 994, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 995, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 996, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 997, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 998, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 999, + "name": "flatten", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1000, + "name": "view", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1001, + "name": "expires_in_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 309, - 323, - 322, - 312, - 308, - 320, - 314, - 307, - 316, - 321, - 311, - 315, - 313, - 317, - 318, - 319, - 310 - ], - "title": "Properties" + 988, + 899, + 927, + 893, + 946, + 986, + 915, + 901, + 983, + 965, + 895 + ] } ], - "id": 306, - "module": "_models", - "name": "Build", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 31, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 368 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L31" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 1002, + "name": "DatasetClientAsync", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single dataset." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, + "id": 1003, + "name": "get", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", "flags": {}, - "groups": [], - "id": 325, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 403 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n\nReturns:\n The retrieved dataset, or None, if it does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 326, - "module": "_models", - "name": "use_cache", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 651, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 407 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L651" } ], - "type": { - "name": "Annotated[bool | None, Field(alias='useCache', examples=[False])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1004, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "bool" + "name": "dict | None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1005, + "name": "update", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n\nArgs:\n name: The new name for the dataset.\n general_access: Determines how others can access the dataset.\n\nReturns:\n The updated dataset." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 327, - "module": "_models", - "name": "beta_packages", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 661, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 408 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L661" } ], - "type": { - "name": "Annotated[bool | None, Field(alias='betaPackages', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" + "signatures": [ + { + "id": 1006, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1007, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1008, + "name": "general_access", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "StorageGeneralAccess | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1009, + "name": "delete", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 328, - "module": "_models", - "name": "memory_mbytes", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 680, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 409 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L680" } ], - "type": { - "name": "Annotated[int | None, Field(alias='memoryMbytes', examples=[1024])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1010, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset" + } + ] + }, + "type": { "type": "reference", - "name": "int" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1011, + "name": "list_items", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\nArgs:\n offset: Number of items that should be skipped at the start. The default value is 0.\n limit: Maximum number of items to return. By default there is no limit.\n desc: By default, results are returned in the same order as they were stored. To reverse the order,\n set this parameter to True.\n clean: If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\n the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\n parameters. Note that since some objects might be skipped from the output, that the result might\n contain less items than the limit value.\n fields: A list of fields which should be picked from the items, only these fields will remain\n in the resulting record objects. Note that the fields in the outputted items are sorted the same\n way as they are specified in the fields parameter. You can use this feature to effectively fix\n the output format.\n omit: A list of fields which should be omitted from the items.\n unwind: A list of fields which should be unwound, in order which they should be processed. Each field\n should be either an array or an object. If the field is an array then every element of the array\n will become a separate record and merged with parent object. If the unwound field is an object then\n it is merged with the parent object. If the unwound field is missing or its value is neither an array\n nor an object and therefore cannot be merged with a parent object, then the item gets preserved\n as it is. Note that the unwound items ignore the desc parameter.\n skip_empty: If True, then empty items are skipped from the output. Note that if used, the results might\n contain less items than the limit value.\n skip_hidden: If True, then hidden fields are skipped from the output, i.e. fields starting with\n the # character.\n flatten: A list of fields that should be flattened.\n view: Name of the dataset view to be used.\n signature: Signature used to access the items.\n\nReturns:\n A page of the list of dataset items according to the specified filters." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 329, - "module": "_models", - "name": "disk_mbytes", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 687, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 410 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L687" } ], - "type": { - "name": "Annotated[int | None, Field(alias='diskMbytes', examples=[2048])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1012, + "name": "list_items", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "int" + "name": "ListPage", + "id": 1725 }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 327, - 329, - 328, - 325, - 326 - ], - "title": "Properties" - } - ], - "id": 324, - "module": "_models", - "name": "BuildOptions", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 402 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "parameters": [ + { + "id": 1013, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1014, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1015, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1016, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1017, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1018, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1019, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1020, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1021, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1022, + "name": "flatten", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1023, + "name": "view", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1024, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1025, + "name": "iterate_items", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Iterate over the items in the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\nArgs:\n offset: Number of items that should be skipped at the start. The default value is 0.\n limit: Maximum number of items to return. By default there is no limit.\n desc: By default, results are returned in the same order as they were stored. To reverse the order,\n set this parameter to True.\n clean: If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\n the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\n parameters. Note that since some objects might be skipped from the output, that the result might\n contain less items than the limit value.\n fields: A list of fields which should be picked from the items, only these fields will remain in\n the resulting record objects. Note that the fields in the outputted items are sorted the same way\n as they are specified in the fields parameter. You can use this feature to effectively fix\n the output format.\n omit: A list of fields which should be omitted from the items.\n unwind: A list of fields which should be unwound, in order which they should be processed. Each field\n should be either an array or an object. If the field is an array then every element of the array\n will become a separate record and merged with parent object. If the unwound field is an object then\n it is merged with the parent object. If the unwound field is missing or its value is neither an array\n nor an object and therefore cannot be merged with a parent object, then the item gets preserved\n as it is. Note that the unwound items ignore the desc parameter.\n skip_empty: If True, then empty items are skipped from the output. Note that if used, the results might\n contain less items than the limit value.\n skip_hidden: If True, then hidden fields are skipped from the output, i.e. fields starting with\n the # character.\n signature: Signature used to access the items.\n\nYields:\n An item from the dataset." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 331, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 776, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 417 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L776" } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 332, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 421 - } - ], - "type": { - "name": "Build", - "type": "reference", - "target": "306" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response containing Actor build data." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 332, - 331 - ], - "title": "Properties" - } - ], - "id": 330, - "module": "_models", - "name": "BuildResponse", - "parsedDocstring": { - "text": "Response containing Actor build data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 414 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 334, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 426 + "id": 1026, + "name": "iterate_items", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the items in the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "AsyncIterator[dict]" + }, + "parameters": [ + { + "id": 1027, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "defaultValue": "0" + }, + { + "id": 1028, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1029, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1030, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1031, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1032, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1033, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1034, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1035, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1036, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, + "id": 1037, + "name": "get_items_as_bytes", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", "flags": {}, - "groups": [], - "id": 335, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 430 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\nArgs:\n item_format: Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\n The default value is json.\n offset: Number of items that should be skipped at the start. The default value is 0.\n limit: Maximum number of items to return. By default there is no limit.\n desc: By default, results are returned in the same order as they were stored. To reverse the order,\n set this parameter to True.\n clean: If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\n the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\n parameters. Note that since some objects might be skipped from the output, that the result might\n contain less items than the limit value.\n bom: All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\n the UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\n to override this default behavior, specify bom=True query parameter to include the BOM or bom=False\n to skip it.\n delimiter: A delimiter character for CSV files. The default delimiter is a simple comma (,).\n fields: A list of fields which should be picked from the items, only these fields will remain\n in the resulting record objects. Note that the fields in the outputted items are sorted the same\n way as they are specified in the fields parameter. You can use this feature to effectively fix\n the output format.\n You can use this feature to effectively fix the output format.\n omit: A list of fields which should be omitted from the items.\n unwind: A list of fields which should be unwound, in order which they should be processed. Each field\n should be either an array or an object. If the field is an array then every element of the array\n will become a separate record and merged with parent object. If the unwound field is an object then\n it is merged with the parent object. If the unwound field is missing or its value is neither an array\n nor an object and therefore cannot be merged with a parent object, then the item gets preserved\n as it is. Note that the unwound items ignore the desc parameter.\n skip_empty: If True, then empty items are skipped from the output. Note that if used, the results might\n contain less items than the limit value.\n skip_header_row: If True, then header row in the csv format is skipped.\n skip_hidden: If True, then hidden fields are skipped from the output, i.e. fields starting with\n the # character.\n xml_root: Overrides default root element name of xml output. By default the root element is items.\n xml_row: Overrides default element name that wraps each page or page function result object in xml output.\n By default the element name is item.\n flatten: A list of fields that should be flattened.\n signature: Signature used to access the items.\n\nReturns:\n The dataset items as raw bytes." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 336, - "module": "_models", - "name": "act_id", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 860, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 431 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L860" } ], - "type": { - "name": "Annotated[str | None, Field(alias='actId', examples=['janedoe~my-actor'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1038, + "name": "get_items_as_bytes", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "bytes" }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 337, - "module": "_models", - "name": "status", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 432 + "parameters": [ + { + "id": 1039, + "name": "item_format", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "defaultValue": "'json'" + }, + { + "id": 1040, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1041, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1042, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1043, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1044, + "name": "bom", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1045, + "name": "delimiter", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1046, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1047, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1048, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1049, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1050, + "name": "skip_header_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1051, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1052, + "name": "xml_root", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1053, + "name": "xml_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1054, + "name": "flatten", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1055, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "ActorJobStatus", - "type": "reference", - "target": "1794" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, + "id": 1056, + "name": "stream_items", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", "flags": {}, - "groups": [], - "id": 338, - "module": "_models", - "name": "started_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 433 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\nArgs:\n item_format: Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\n The default value is json.\n offset: Number of items that should be skipped at the start. The default value is 0.\n limit: Maximum number of items to return. By default there is no limit.\n desc: By default, results are returned in the same order as they were stored. To reverse the order,\n set this parameter to True.\n clean: If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\n the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\n parameters. Note that since some objects might be skipped from the output, that the result might\n contain less items than the limit value.\n bom: All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\n the UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\n to override this default behavior, specify bom=True query parameter to include the BOM or bom=False\n to skip it.\n delimiter: A delimiter character for CSV files. The default delimiter is a simple comma (,).\n fields: A list of fields which should be picked from the items, only these fields will remain\n in the resulting record objects. Note that the fields in the outputted items are sorted the same\n way as they are specified in the fields parameter. You can use this feature to effectively fix\n the output format.\n You can use this feature to effectively fix the output format.\n omit: A list of fields which should be omitted from the items.\n unwind: A list of fields which should be unwound, in order which they should be processed. Each field\n should be either an array or an object. If the field is an array then every element of the array\n will become a separate record and merged with parent object. If the unwound field is an object then\n it is merged with the parent object. If the unwound field is missing or its value is neither an array\n nor an object and therefore cannot be merged with a parent object, then the item gets preserved\n as it is. Note that the unwound items ignore the desc parameter.\n skip_empty: If True, then empty items are skipped from the output. Note that if used, the results might\n contain less items than the limit value.\n skip_header_row: If True, then header row in the csv format is skipped.\n skip_hidden: If True, then hidden fields are skipped from the output, i.e. fields starting with\n the # character.\n xml_root: Overrides default root element name of xml output. By default the root element is items.\n xml_row: Overrides default element name that wraps each page or page function result object in xml output.\n By default the element name is item.\n signature: Signature used to access the items.\n\nReturns:\n The dataset items as a context-managed streaming `Response`." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 339, - "module": "_models", - "name": "finished_at", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 956, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 434 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L956" } ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1057, + "name": "stream_items", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "AwareDatetime" + "name": "AsyncIterator[impit.Response]" }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 340, - "module": "_models", - "name": "usage_total_usd", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 437 - } - ], - "type": { - "name": "float", - "type": "reference" - } + "parameters": [ + { + "id": 1058, + "name": "item_format", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "defaultValue": "'json'" + }, + { + "id": 1059, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1060, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1061, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1062, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1063, + "name": "bom", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1064, + "name": "delimiter", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1065, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1066, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1067, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1068, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1069, + "name": "skip_header_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1070, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1071, + "name": "xml_root", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1072, + "name": "xml_row", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1073, + "name": "signature", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1074, + "name": "push_items", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n\nArgs:\n items: The items which to push in the dataset. Either a stringified JSON, a dictionary, or a list\n of strings or dictionaries." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 341, - "module": "_models", - "name": "meta", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 1053, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 438 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L1053" } ], - "type": { - "name": "BuildsMeta | None", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1075, + "name": "push_items", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "BuildsMeta", - "target": "353" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 336, - 339, - 335, - 341, - 334, - 338, - 337, - 340 - ], - "title": "Properties" - } - ], - "id": 333, - "module": "_models", - "name": "BuildShort", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 425 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 343, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 443 + "parameters": [ + { + "id": 1076, + "name": "items", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "JSONSerializable", + "id": 1724 + } + } + ] } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1077, + "name": "get_statistics", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n\nReturns:\n The dataset statistics or None if the dataset does not exist." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 344, - "module": "_models", - "name": "duration_millis", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 1080, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 447 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L1080" } ], - "type": { - "name": "Annotated[int | None, Field(alias='durationMillis', examples=[1000])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1078, + "name": "get_statistics", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "int" + "name": "dict | None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1079, + "name": "create_items_public_url", + "module": "apify_client.clients.resource_clients.dataset", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in_secs` option.\nThis value sets the expiration duration in seconds from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n\nReturns:\n The public dataset items URL." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 345, - "module": "_models", - "name": "run_time_secs", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 1101, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 448 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L1101" } ], - "type": { - "name": "Annotated[float | None, Field(alias='runTimeSecs', examples=[45.718])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 346, - "module": "_models", - "name": "compute_units", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 449 + "id": 1080, + "name": "create_items_public_url", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in_secs` option.\nThis value sets the expiration duration in seconds from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 1081, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1082, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1083, + "name": "clean", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1084, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1085, + "name": "fields", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1086, + "name": "omit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1087, + "name": "unwind", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1088, + "name": "skip_empty", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1089, + "name": "skip_hidden", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1090, + "name": "flatten", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1091, + "name": "view", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1092, + "name": "expires_in_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "float", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 346, - 344, - 343, - 345 - ], - "title": "Properties" + 1079, + 1009, + 1003, + 1037, + 1077, + 1025, + 1011, + 1074, + 1056, + 1005 + ] } ], - "id": 342, - "module": "_models", - "name": "BuildStats", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/dataset.py", + "line": 644, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 442 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/dataset.py#L644" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 1093, + "name": "BuildCollectionClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for listing Actor builds." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { + "id": 1094, + "name": "list", + "module": "apify_client.clients.resource_clients.build_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { "kind": "text", - "text": "" + "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n\nArgs:\n limit: How many builds to retrieve.\n offset: What build to include as first when retrieving the list.\n desc: Whether to sort the builds in descending order based on their start date.\n\nReturns:\n The retrieved Actor builds." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 348, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/build_collection.py", + "line": 18, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 454 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build_collection.py#L18" } ], - "type": { - "name": "Undefined", - "type": "reference" + "signatures": [ + { + "id": 1095, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 1096, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1097, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1098, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1094 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/build_collection.py", + "line": 11, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build_collection.py#L11" + } + ] + }, + { + "id": 1099, + "name": "BuildCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for listing Actor builds." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1100, + "name": "list", + "module": "apify_client.clients.resource_clients.build_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n\nArgs:\n limit: How many builds to retrieve.\n offset: What build to include as first when retrieving the list.\n desc: Whether to sort the builds in descending order based on their start date.\n\nReturns:\n The retrieved Actor builds." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 349, - "module": "_models", - "name": "build_id", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/build_collection.py", + "line": 51, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 458 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build_collection.py#L51" } ], - "type": { - "name": "str", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + "signatures": [ + { + "id": 1101, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 1102, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1103, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1104, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 349, - 348 - ], - "title": "Properties" + 1100 + ] } ], - "id": 347, - "module": "_models", - "name": "BuildTag", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/build_collection.py", + "line": 44, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 453 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build_collection.py#L44" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 1105, + "name": "BuildClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single Actor build." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1106, + "name": "get", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n\nReturns:\n The retrieved Actor build data." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 351, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 16, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 463 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L16" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 1107, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1108, + "name": "delete", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 352, - "module": "_models", - "name": "actor_compute_units", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 26, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 467 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L26" } ], - "type": { - "name": "Annotated[float | None, Field(alias='ACTOR_COMPUTE_UNITS', examples=[0.08])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1109, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build" + } + ] + }, + "type": { "type": "reference", - "name": "float" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 352, - 351 - ], - "title": "Properties" - } - ], - "id": 350, - "module": "_models", - "name": "BuildUsage", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 462 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "parameters": [] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1110, + "name": "abort", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n\nReturns:\n The data of the aborted Actor build." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 354, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 33, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 472 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L33" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 1111, + "name": "abort", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1112, + "name": "get_open_api_definition", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n\nReturns:\n OpenAPI definition of the Actor's build." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 355, - "module": "_models", - "name": "origin", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 43, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 476 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L43" } ], - "type": { - "name": "RunOrigin", - "type": "reference", - "target": "1799" - } + "signatures": [ + { + "id": 1113, + "name": "get_open_api_definition", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1114, + "name": "wait_for_finish", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "IP address of the client that started the build." + "text": "Wait synchronously until the build finishes or the server times out.\n\nArgs:\n wait_secs: How long does the client wait for build to finish. None for indefinite.\n\nReturns:\n The Actor build data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\n TIMED_OUT, ABORTED), then the build has not yet finished." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 356, - "module": "_models", - "name": "client_ip", - "parsedDocstring": { - "text": "IP address of the client that started the build." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 60, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 477 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L60" } ], - "type": { - "name": "Annotated[str | None, Field(alias='clientIp', examples=['172.234.12.34'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1115, + "name": "wait_for_finish", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wait synchronously until the build finishes or the server times out.\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "dict | None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 1116, + "name": "wait_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1117, + "name": "log", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "User agent of the client that started the build." + "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n\nReturns:\n A client allowing access to the log of this Actor build." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 357, - "module": "_models", - "name": "user_agent", - "parsedDocstring": { - "text": "User agent of the client that started the build." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 72, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 481 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L72" } ], - "type": { - "name": "Annotated[str | None, Field(alias='userAgent', examples=['Mozilla/5.0 (iPad)'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1118, + "name": "log", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "LogClient", + "id": 662 }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + "parameters": [] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 356, - 354, - 355, - 357 - ], - "title": "Properties" + 1110, + 1108, + 1106, + 1112, + 1117, + 1114 + ] } ], - "id": 353, - "module": "_models", - "name": "BuildsMeta", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 9, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 471 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L9" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 1119, + "name": "BuildClientAsync", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single Actor build." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1120, + "name": "get", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n\nReturns:\n The retrieved Actor build data." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 359, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 92, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 489 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L92" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 1121, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1122, + "name": "abort", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n\nReturns:\n The data of the aborted Actor build." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 360, - "module": "_models", - "name": "started_at", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 102, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 493 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L102" } ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='startedAt', examples=['2019-12-12T07:34:14.202Z'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], + "signatures": [ + { + "id": 1123, + "name": "abort", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [] + } + ] + }, + { + "id": 1124, + "name": "delete", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 361, - "module": "_models", - "name": "finished_at", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 112, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 494 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L112" } ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-12T07:34:14.202Z'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1125, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build" + } + ] + }, + "type": { "type": "reference", - "name": "AwareDatetime" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1126, + "name": "get_open_api_definition", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n\nReturns:\n OpenAPI definition of the Actor's build." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 362, - "module": "_models", - "name": "error_message", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 119, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 497 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L119" } ], - "type": { - "name": "Annotated[str | None, Field(alias='errorMessage', examples=['Cannot send request'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1127, + "name": "get_open_api_definition", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "dict | None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1128, + "name": "wait_for_finish", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Wait synchronously until the build finishes or the server times out.\n\nArgs:\n wait_secs: How long does the client wait for build to finish. None for indefinite.\n\nReturns:\n The Actor build data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\n TIMED_OUT, ABORTED), then the build has not yet finished." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 363, - "module": "_models", - "name": "response_status", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 136, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 498 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L136" } ], - "type": { - "name": "Annotated[int | None, Field(alias='responseStatus', examples=[200])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1129, + "name": "wait_for_finish", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wait synchronously until the build finishes or the server times out.\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "int" + "name": "dict | None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 1130, + "name": "wait_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1131, + "name": "log", + "module": "apify_client.clients.resource_clients.build", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n\nReturns:\n A client allowing access to the log of this Actor build." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 364, - "module": "_models", - "name": "response_body", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 148, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 499 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L148" } ], - "type": { - "name": "Annotated[str | None, Field(alias='responseBody', examples=['{\"foo\": \"bar\"}'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1132, + "name": "log", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "LogClientAsync", + "id": 672 }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + "parameters": [] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 362, - 361, - 359, - 364, - 363, - 360 - ], - "title": "Properties" + 1122, + 1124, + 1120, + 1126, + 1131, + 1128 + ] } ], - "id": 358, - "module": "_models", - "name": "Call", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/build.py", + "line": 85, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 488 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/build.py#L85" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 1133, + "name": "ActorVersionCollectionClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating Actor versions." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1134, + "name": "list", + "module": "apify_client.clients.resource_clients.actor_version_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n\nReturns:\n The list of available Actor versions." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 366, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_version_collection.py", + "line": 22, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 504 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version_collection.py#L22" } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 367, - "module": "_models", - "name": "event_name", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 508 + "id": 1135, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [] } - ], - "type": { - "name": "str", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1136, + "name": "create", + "module": "apify_client.clients.resource_clients.actor_version_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n\nArgs:\n version_number: Major and minor version of the Actor (e.g. `1.0`).\n build_tag: Tag that is automatically set to the latest successful build of the current version.\n env_vars: Environment variables that will be available to the Actor run process, and optionally\n also to the build process. See the API docs for their exact structure.\n apply_env_vars_to_build: Whether the environment variables specified for the Actor run will also\n be set to the Actor build process.\n source_type: What source type is the Actor version using.\n source_files: Source code comprised of multiple files, each an item of the array. Required\n when `source_type` is `ActorSourceType.SOURCE_FILES`. See the API docs for the exact structure.\n git_repo_url: The URL of a Git repository from which the source code will be cloned.\n Required when `source_type` is `ActorSourceType.GIT_REPO`.\n tarball_url: The URL of a tarball or a zip archive from which the source code will be downloaded.\n Required when `source_type` is `ActorSourceType.TARBALL`.\n github_gist_url: The URL of a GitHub Gist from which the source will be downloaded.\n Required when `source_type` is `ActorSourceType.GITHUB_GIST`.\n\nReturns:\n The created Actor version." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 368, - "module": "_models", - "name": "count", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_version_collection.py", + "line": 32, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 509 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version_collection.py#L32" } ], - "type": { - "name": "int", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + "signatures": [ + { + "id": 1137, + "name": "create", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1138, + "name": "version_number", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1139, + "name": "build_tag", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1140, + "name": "env_vars", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1141, + "name": "apply_env_vars_to_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1142, + "name": "source_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorSourceType", + "id": 1772 + } + }, + { + "id": 1143, + "name": "source_files", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1144, + "name": "git_repo_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1145, + "name": "tarball_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1146, + "name": "github_gist_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 368, - 367, - 366 - ], - "title": "Properties" + 1136, + 1134 + ] } ], - "id": 365, - "module": "_models", - "name": "ChargeRunRequest", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_version_collection.py", + "line": 15, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 503 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version_collection.py#L15" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 1147, + "name": "ActorVersionCollectionClientAsync", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating Actor versions." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, + "id": 1148, + "name": "list", + "module": "apify_client.clients.resource_clients.actor_version_collection", + "kind": 2048, + "kindString": "Method", "flags": {}, - "groups": [], - "id": 370, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 514 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" + "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n\nReturns:\n The list of available Actor versions." } ] }, - "flags": {}, - "groups": [], - "id": 371, - "module": "_models", - "name": "apify_margin_percentage", - "parsedDocstring": { - "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 518 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "When this pricing info record has been created" - } - ] - }, - "flags": {}, "groups": [], - "id": 372, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "When this pricing info record has been created" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_version_collection.py", + "line": 91, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 522 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version_collection.py#L91" } ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Since when is this pricing info record effective for a given Actor" - } - ] - }, - "flags": {}, - "groups": [], - "id": 373, - "module": "_models", - "name": "started_at", - "parsedDocstring": { - "text": "Since when is this pricing info record effective for a given Actor" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 526 + "id": 1149, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [] } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1150, + "name": "create", + "module": "apify_client.clients.resource_clients.actor_version_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n\nArgs:\n version_number: Major and minor version of the Actor (e.g. `1.0`).\n build_tag: Tag that is automatically set to the latest successful build of the current version.\n env_vars: Environment variables that will be available to the Actor run process, and optionally\n also to the build process. See the API docs for their exact structure.\n apply_env_vars_to_build: Whether the environment variables specified for the Actor run will also\n be set to the Actor build process.\n source_type: What source type is the Actor version using.\n source_files: Source code comprised of multiple files, each an item of the array. Required\n when `source_type` is `ActorSourceType.SOURCE_FILES`. See the API docs for the exact structure.\n git_repo_url: The URL of a Git repository from which the source code will be cloned.\n Required when `source_type` is `ActorSourceType.GIT_REPO`.\n tarball_url: The URL of a tarball or a zip archive from which the source code will be downloaded.\n Required when `source_type` is `ActorSourceType.TARBALL`.\n github_gist_url: The URL of a GitHub Gist from which the source will be downloaded.\n Required when `source_type` is `ActorSourceType.GITHUB_GIST`.\n\nReturns:\n The created Actor version." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 374, - "module": "_models", - "name": "notified_about_future_change_at", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_version_collection.py", + "line": 101, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 530 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version_collection.py#L101" } ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutFutureChangeAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 375, - "module": "_models", - "name": "notified_about_change_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 531 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutChangeAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" + "id": 1151, + "name": "create", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 376, - "module": "_models", - "name": "reason_for_change", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 532 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='reasonForChange')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + "type": { + "type": "intrinsic", + "name": "dict" }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + "parameters": [ + { + "id": 1152, + "name": "version_number", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1153, + "name": "build_tag", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1154, + "name": "env_vars", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1155, + "name": "apply_env_vars_to_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1156, + "name": "source_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorSourceType", + "id": 1772 + } + }, + { + "id": 1157, + "name": "source_files", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1158, + "name": "git_repo_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1159, + "name": "tarball_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1160, + "name": "github_gist_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 371, - 372, - 370, - 375, - 374, - 376, - 373 - ], - "title": "Properties" + 1150, + 1148 + ] } ], - "id": 369, - "module": "_models", - "name": "CommonActorPricingInfo", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_version_collection.py", + "line": 84, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 513 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "FlatPricePerMonthActorPricingInfo", - "target": "570", - "type": "reference" - }, - { - "name": "FreeActorPricingInfo", - "target": "575", - "type": "reference" - }, - { - "name": "PayPerEventActorPricingInfo", - "target": "786", - "type": "reference" - }, - { - "name": "PricePerDatasetItemActorPricingInfo", - "target": "813", - "type": "reference" + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version_collection.py#L84" } ] }, { + "id": 1161, + "name": "ActorVersionClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single Actor version." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1162, + "name": "get", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n\nReturns:\n The retrieved Actor version data." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 378, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 49, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 537 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L49" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 1163, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1164, + "name": "update", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n\nArgs:\n build_tag: Tag that is automatically set to the latest successful build of the current version.\n env_vars: Environment variables that will be available to the Actor run process, and optionally\n also to the build process. See the API docs for their exact structure.\n apply_env_vars_to_build: Whether the environment variables specified for the Actor run will also\n be set to the Actor build process.\n source_type: What source type is the Actor version using.\n source_files: Source code comprised of multiple files, each an item of the array. Required when\n `source_type` is `ActorSourceType.SOURCE_FILES`. See the API docs for the exact structure.\n git_repo_url: The URL of a Git repository from which the source code will be cloned.\n Required when `source_type` is `ActorSourceType.GIT_REPO`.\n tarball_url: The URL of a tarball or a zip archive from which the source code will be downloaded.\n Required when `source_type` is `ActorSourceType.TARBALL`.\n github_gist_url: The URL of a GitHub Gist from which the source will be downloaded.\n Required when `source_type` is `ActorSourceType.GITHUB_GIST`.\n\nReturns:\n The updated Actor version." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 379, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 59, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 541 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L59" } ], - "type": { - "name": "Annotated[str | None, Field(examples=['MyActor'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + "signatures": [ + { + "id": 1165, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1166, + "name": "build_tag", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1167, + "name": "env_vars", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1168, + "name": "apply_env_vars_to_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1169, + "name": "source_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorSourceType | None" + }, + "defaultValue": "None" + }, + { + "id": 1170, + "name": "source_files", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1171, + "name": "git_repo_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1172, + "name": "tarball_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1173, + "name": "github_gist_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1174, + "name": "delete", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 380, - "module": "_models", - "name": "description", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 107, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 542 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L107" } ], - "type": { - "name": "Annotated[str | None, Field(examples=['My favourite actor!'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1175, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1176, + "name": "env_vars", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve a client for the environment variables of this Actor version." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 381, - "module": "_models", - "name": "title", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 114, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 543 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L114" } ], - "type": { - "name": "Annotated[str | None, Field(examples=['My actor'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1177, + "name": "env_vars", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the environment variables of this Actor version." + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "ActorEnvVarCollectionClient", + "id": 1201 }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1178, + "name": "env_var", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the client for the specified environment variable of this Actor version.\n\nArgs:\n env_var_name: The name of the environment variable for which to retrieve the resource client.\n\nReturns:\n The resource client for the specified Actor environment variable." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 382, - "module": "_models", - "name": "is_public", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 118, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 544 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L118" } ], - "type": { - "name": "Annotated[bool | None, Field(alias='isPublic', examples=[False])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1179, + "name": "env_var", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified environment variable of this Actor version.\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "bool" + "name": "ActorEnvVarClient", + "id": 1222 }, - { - "type": "literal", - "value": null - } - ] + "parameters": [ + { + "id": 1180, + "name": "env_var_name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1174, + 1178, + 1176, + 1162, + 1164 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 42, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L42" + } + ] + }, + { + "id": 1181, + "name": "ActorVersionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single Actor version." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1182, + "name": "get", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n\nReturns:\n The retrieved Actor version data." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 383, - "module": "_models", - "name": "seo_title", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 137, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 545 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L137" } ], - "type": { - "name": "Annotated[str | None, Field(alias='seoTitle', examples=['My actor'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1183, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "dict | None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1184, + "name": "update", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n\nArgs:\n build_tag: Tag that is automatically set to the latest successful build of the current version.\n env_vars: Environment variables that will be available to the Actor run process, and optionally\n also to the build process. See the API docs for their exact structure.\n apply_env_vars_to_build: Whether the environment variables specified for the Actor run will also\n be set to the Actor build process.\n source_type: What source type is the Actor version using.\n source_files: Source code comprised of multiple files, each an item of the array. Required when\n `source_type` is `ActorSourceType.SOURCE_FILES`. See the API docs for the exact structure.\n git_repo_url: The URL of a Git repository from which the source code will be cloned.\n Required when `source_type` is `ActorSourceType.GIT_REPO`.\n tarball_url: The URL of a tarball or a zip archive from which the source code will be downloaded.\n Required when `source_type` is `ActorSourceType.TARBALL`.\n github_gist_url: The URL of a GitHub Gist from which the source will be downloaded.\n Required when `source_type` is `ActorSourceType.GITHUB_GIST`.\n\nReturns:\n The updated Actor version." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 384, - "module": "_models", - "name": "seo_description", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 147, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 546 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L147" } ], - "type": { - "name": "Annotated[str | None, Field(alias='seoDescription', examples=['My actor is the best'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + "signatures": [ + { + "id": 1185, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1186, + "name": "build_tag", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1187, + "name": "env_vars", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1188, + "name": "apply_env_vars_to_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1189, + "name": "source_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorSourceType | None" + }, + "defaultValue": "None" + }, + { + "id": 1190, + "name": "source_files", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1191, + "name": "git_repo_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1192, + "name": "tarball_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1193, + "name": "github_gist_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1194, + "name": "delete", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 385, - "module": "_models", - "name": "restart_on_error", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 195, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 547 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L195" } ], - "type": { - "name": "Annotated[bool | None, Field(alias='restartOnError', deprecated=True, examples=[False])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1195, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version" + } + ] + }, + "type": { "type": "reference", - "name": "bool" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1196, + "name": "env_vars", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve a client for the environment variables of this Actor version." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 386, - "module": "_models", - "name": "versions", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 202, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 548 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L202" } ], - "type": { - "name": "list[Version] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ + "signatures": [ + { + "id": 1197, + "name": "env_vars", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "reference", - "name": "Version", - "target": "1336" + "kind": "text", + "text": "Retrieve a client for the environment variables of this Actor version." } - ], - "target": "2199" + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "reference", + "name": "ActorEnvVarCollectionClientAsync", + "id": 1209 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1198, + "name": "env_var", + "module": "apify_client.clients.resource_clients.actor_version", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the client for the specified environment variable of this Actor version.\n\nArgs:\n env_var_name: The name of the environment variable for which to retrieve the resource client.\n\nReturns:\n The resource client for the specified Actor environment variable." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 387, - "module": "_models", - "name": "pricing_infos", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 206, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 549 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L206" } ], - "type": { - "name": "Annotated[ list[ Annotated[ PayPerEventActorPricingInfo | PricePerDatasetItemActorPricingInfo | FlatPricePerMonthActorPricingInfo | FreeActorPricingInfo, Field(discriminator='pricing_model'), ] ] | None, Field(alias='pricingInfos'), ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ + "signatures": [ + { + "id": 1199, + "name": "env_var", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "PayPerEventActorPricingInfo", - "target": "786" - }, - { - "type": "reference", - "name": "PricePerDatasetItemActorPricingInfo", - "target": "813" - } - ] - }, - { - "type": "reference", - "name": "FlatPricePerMonthActorPricingInfo", - "target": "570" - } - ] - }, - { - "type": "reference", - "name": "FreeActorPricingInfo", - "target": "575" - } - ] + "kind": "text", + "text": "Retrieve the client for the specified environment variable of this Actor version.\n\n" } - ], - "target": "2199" + ] }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 388, - "module": "_models", - "name": "categories", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 562 - } - ], - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { + "type": { "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", + "name": "ActorEnvVarClientAsync", + "id": 1232 + }, + "parameters": [ + { + "id": 1200, + "name": "env_var_name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", "name": "str" } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1194, + 1198, + 1196, + 1182, + 1184 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_version.py", + "line": 130, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_version.py#L130" + } + ] + }, + { + "id": 1201, + "name": "ActorEnvVarCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating actor env vars." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1202, + "name": "list", + "module": "apify_client.clients.resource_clients.actor_env_var_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List the available actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n\nReturns:\n The list of available actor environment variables." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 389, - "module": "_models", - "name": "default_run_options", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var_collection.py", + "line": 20, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 563 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var_collection.py#L20" } ], - "type": { - "name": "Annotated[DefaultRunOptions | None, Field(alias='defaultRunOptions')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1203, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "DefaultRunOptions", - "target": "499" + "name": "ListPage[dict]" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1204, + "name": "create", + "module": "apify_client.clients.resource_clients.actor_env_var_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Create a new actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n\nArgs:\n is_secret: Whether the environment variable is secret or not.\n name: The name of the environment variable.\n value: The value of the environment variable.\n\nReturns:\n The created actor environment variable." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 390, - "module": "_models", - "name": "actor_standby", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var_collection.py", + "line": 30, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 564 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var_collection.py#L30" } ], - "type": { - "name": "Annotated[ActorStandby | None, Field(alias='actorStandby')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorStandby", - "target": "255" + "signatures": [ + { + "id": 1205, + "name": "create", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1206, + "name": "is_secret", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1207, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1208, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1204, + 1202 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var_collection.py", + "line": 13, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var_collection.py#L13" + } + ] + }, + { + "id": 1209, + "name": "ActorEnvVarCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating actor env vars." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1210, + "name": "list", + "module": "apify_client.clients.resource_clients.actor_env_var_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List the available actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n\nReturns:\n The list of available actor environment variables." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 391, - "module": "_models", - "name": "example_run_input", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var_collection.py", + "line": 65, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 565 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var_collection.py#L65" } ], - "type": { - "name": "Annotated[ExampleRunInput | None, Field(alias='exampleRunInput')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1211, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "ExampleRunInput", - "target": "562" + "name": "ListPage[dict]" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1212, + "name": "create", + "module": "apify_client.clients.resource_clients.actor_env_var_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Create a new actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n\nArgs:\n is_secret: Whether the environment variable is secret or not.\n name: The name of the environment variable.\n value: The value of the environment variable.\n\nReturns:\n The created actor environment variable." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 392, - "module": "_models", - "name": "is_deprecated", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var_collection.py", + "line": 75, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 566 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var_collection.py#L75" } ], - "type": { - "name": "Annotated[bool | None, Field(alias='isDeprecated')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + "signatures": [ + { + "id": 1213, + "name": "create", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1214, + "name": "is_secret", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1215, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1216, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 390, - 388, - 389, - 380, - 391, - 392, - 382, - 378, - 379, - 387, - 385, - 384, - 383, - 381, - 386 - ], - "title": "Properties" + 1212, + 1210 + ] } ], - "id": 377, - "module": "_models", - "name": "CreateActorRequest", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var_collection.py", + "line": 58, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 536 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var_collection.py#L58" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 128, - "kindString": "Class", - "children": [ + "id": 1217, + "name": "get_actor_env_var_representation", + "module": "apify_client.clients.resource_clients.actor_env_var", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return an environment variable representation of the Actor in a dictionary." + } + ] + }, + "children": [], + "groups": [], + "sources": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "filename": "/src/apify_client/clients/resource_clients/actor_env_var.py", + "line": 9, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var.py#L9" + } + ], + "signatures": [ + { + "id": 1218, + "name": "get_actor_env_var_representation", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Return an environment variable representation of the Actor in a dictionary." } ] }, - "flags": {}, - "groups": [], - "id": 394, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "intrinsic", + "name": "dict" }, - "sources": [ + "parameters": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 571 + "id": 1219, + "name": "is_secret", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1220, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1221, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" } - ], - "type": { - "name": "Undefined", - "type": "reference" + ] + } + ] + }, + { + "id": 1222, + "name": "ActorEnvVarClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single Actor environment variable." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1223, + "name": "get", + "module": "apify_client.clients.resource_clients.actor_env_var", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n\nReturns:\n The retrieved Actor environment variable data." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 395, - "module": "_models", - "name": "version_number", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var.py", + "line": 30, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 575 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var.py#L30" } ], - "type": { - "name": "Annotated[str | None, Field(alias='versionNumber', examples=['0.0'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1224, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "dict | None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1225, + "name": "update", + "module": "apify_client.clients.resource_clients.actor_env_var", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n\nArgs:\n is_secret: Whether the environment variable is secret or not.\n name: The name of the environment variable.\n value: The value of the environment variable.\n\nReturns:\n The updated Actor environment variable." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 396, - "module": "_models", - "name": "source_type", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var.py", + "line": 40, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 576 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var.py#L40" } ], - "type": { - "name": "Annotated[VersionSourceType | None, Field(alias='sourceType')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "VersionSourceType", - "target": "1802" + "signatures": [ + { + "id": 1226, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1227, + "name": "is_secret", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1228, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1229, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1230, + "name": "delete", + "module": "apify_client.clients.resource_clients.actor_env_var", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 397, - "module": "_models", - "name": "env_vars", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var.py", + "line": 67, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 577 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var.py#L67" } ], - "type": { - "name": "Annotated[list[EnvVarRequest] | None, Field(alias='envVars')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ + "signatures": [ + { + "id": 1231, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "reference", - "name": "EnvVarRequest", - "target": "546" + "kind": "text", + "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable" } - ], - "target": "2199" + ] }, - { - "type": "literal", - "value": null - } - ] + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1230, + 1223, + 1225 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var.py", + "line": 23, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var.py#L23" + } + ] + }, + { + "id": 1232, + "name": "ActorEnvVarClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single Actor environment variable." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1233, + "name": "get", + "module": "apify_client.clients.resource_clients.actor_env_var", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n\nReturns:\n The retrieved Actor environment variable data." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 398, - "module": "_models", - "name": "apply_env_vars_to_build", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var.py", + "line": 82, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 578 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var.py#L82" } ], - "type": { - "name": "Annotated[bool | None, Field(alias='applyEnvVarsToBuild', examples=[False])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1234, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "bool" + "name": "dict | None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1235, + "name": "update", + "module": "apify_client.clients.resource_clients.actor_env_var", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n\nArgs:\n is_secret: Whether the environment variable is secret or not.\n name: The name of the environment variable.\n value: The value of the environment variable.\n\nReturns:\n The updated Actor environment variable." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 399, - "module": "_models", - "name": "build_tag", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var.py", + "line": 92, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 579 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var.py#L92" } ], - "type": { - "name": "Annotated[str | None, Field(alias='buildTag', examples=['latest'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + "signatures": [ + { + "id": 1236, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1237, + "name": "is_secret", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1238, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1239, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1240, + "name": "delete", + "module": "apify_client.clients.resource_clients.actor_env_var", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 400, - "module": "_models", - "name": "source_files", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var.py", + "line": 119, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 580 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var.py#L119" } ], - "type": { - "name": "Annotated[ list[SourceCodeFile | SourceCodeFolder] | None, Field(alias='sourceFiles', title='VersionSourceFiles') ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ + "signatures": [ + { + "id": 1241, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "union", - "types": [ - { - "type": "reference", - "name": "SourceCodeFile", - "target": "1158" - }, - { - "type": "reference", - "name": "SourceCodeFolder", - "target": "1163" - } - ] + "kind": "text", + "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable" } - ], - "target": "2199" + ] }, - { - "type": "literal", - "value": null - } - ] + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1240, + 1233, + 1235 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_env_var.py", + "line": 75, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_env_var.py#L75" + } + ] + }, + { + "id": 1242, + "name": "ActorCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating Actors." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1243, + "name": "list", + "module": "apify_client.clients.resource_clients.actor_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "URL of the Git repository when sourceType is GIT_REPO." + "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n\nArgs:\n my: If True, will return only Actors which the user has created themselves.\n limit: How many Actors to list.\n offset: What Actor to include as first when retrieving the list.\n desc: Whether to sort the Actors in descending order based on their creation date.\n sort_by: Field to sort the results by.\n\nReturns:\n The list of available Actors matching the specified filters." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 401, - "module": "_models", - "name": "git_repo_url", - "parsedDocstring": { - "text": "URL of the Git repository when sourceType is GIT_REPO." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_collection.py", + "line": 20, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 583 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_collection.py#L20" } ], - "type": { - "name": "Annotated[str | None, Field(alias='gitRepoUrl')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the tarball when sourceType is TARBALL." - } - ] - }, - "flags": {}, - "groups": [], - "id": 402, - "module": "_models", - "name": "tarball_url", - "parsedDocstring": { - "text": "URL of the tarball when sourceType is TARBALL." - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 587 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='tarballUrl')]", - "type": "union", - "types": [ - { + "id": 1244, + "name": "list", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "ListPage[dict]" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 1245, + "name": "my", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1246, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1247, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1248, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1249, + "name": "sort_by", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Literal['createdAt', 'stats.lastRunStartedAt'] | None" + }, + "defaultValue": "'createdAt'" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1250, + "name": "create", + "module": "apify_client.clients.resource_clients.actor_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "URL of the GitHub Gist when sourceType is GITHUB_GIST." + "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n\nArgs:\n name: The name of the Actor.\n title: The title of the Actor (human-readable).\n description: The description for the Actor.\n seo_title: The title of the Actor optimized for search engines.\n seo_description: The description of the Actor optimized for search engines.\n versions: The list of Actor versions.\n restart_on_error: If true, the Actor run process will be restarted whenever it exits with\n a non-zero status code.\n is_public: Whether the Actor is public.\n is_deprecated: Whether the Actor is deprecated.\n is_anonymously_runnable: Whether the Actor is anonymously runnable.\n categories: The categories to which the Actor belongs to.\n default_run_build: Tag or number of the build that you want to run by default.\n default_run_max_items: Default limit of the number of results that will be returned by runs\n of this Actor, if the Actor is charged per result.\n default_run_memory_mbytes: Default amount of memory allocated for the runs of this Actor, in megabytes.\n default_run_timeout_secs: Default timeout for the runs of this Actor in seconds.\n example_run_input_body: Input to be prefilled as default input to new users of this Actor.\n example_run_input_content_type: The content type of the example run input.\n actor_standby_is_enabled: Whether the Actor Standby is enabled.\n actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_max_requests_per_actor_run: The maximum number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_idle_timeout_secs: If the Actor run does not receive any requests for this time,\n it will be shut down.\n actor_standby_build: The build tag or number to run when the Actor is in Standby mode.\n actor_standby_memory_mbytes: The memory in megabytes to use when the Actor is in Standby mode.\n\nReturns:\n The created Actor." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 403, - "module": "_models", - "name": "github_gist_url", - "parsedDocstring": { - "text": "URL of the GitHub Gist when sourceType is GITHUB_GIST." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_collection.py", + "line": 45, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 591 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_collection.py#L45" } ], - "type": { - "name": "Annotated[str | None, Field(alias='gitHubGistUrl')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" + "signatures": [ + { + "id": 1251, + "name": "create", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1252, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1253, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1254, + "name": "description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1255, + "name": "seo_title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1256, + "name": "seo_description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1257, + "name": "versions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1258, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1259, + "name": "is_public", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1260, + "name": "is_deprecated", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1261, + "name": "is_anonymously_runnable", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1262, + "name": "categories", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1263, + "name": "default_run_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1264, + "name": "default_run_max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1265, + "name": "default_run_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1266, + "name": "default_run_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1267, + "name": "example_run_input_body", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1268, + "name": "example_run_input_content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1269, + "name": "actor_standby_is_enabled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1270, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1271, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1272, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1273, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1274, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Methods", "children": [ - 398, - 399, - 397, - 401, - 403, - 394, - 400, - 396, - 402, - 395 - ], - "title": "Properties" + 1250, + 1243 + ] } ], - "id": 393, - "module": "_models", - "name": "CreateOrUpdateVersionRequest", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_collection.py", + "line": 13, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 570 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_collection.py#L13" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 1275, + "name": "ActorCollectionClientAsync", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating Actors." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1276, + "name": "list", + "module": "apify_client.clients.resource_clients.actor_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n\nArgs:\n my: If True, will return only Actors which the user has created themselves.\n limit: How many Actors to list.\n offset: What Actor to include as first when retrieving the list.\n desc: Whether to sort the Actors in descending order based on their creation date.\n sort_by: Field to sort the results by.\n\nReturns:\n The list of available Actors matching the specified filters." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 405, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_collection.py", + "line": 145, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 599 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_collection.py#L145" } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 406, - "module": "_models", - "name": "act_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 603 + "id": 1277, + "name": "list", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ListPage[dict]" + }, + "parameters": [ + { + "id": 1278, + "name": "my", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1279, + "name": "limit", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1280, + "name": "offset", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1281, + "name": "desc", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1282, + "name": "sort_by", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Literal['createdAt', 'stats.lastRunStartedAt'] | None" + }, + "defaultValue": "'createdAt'" + } + ] } - ], - "type": { - "name": "str", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1283, + "name": "create", + "module": "apify_client.clients.resource_clients.actor_collection", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n\nArgs:\n name: The name of the Actor.\n title: The title of the Actor (human-readable).\n description: The description for the Actor.\n seo_title: The title of the Actor optimized for search engines.\n seo_description: The description of the Actor optimized for search engines.\n versions: The list of Actor versions.\n restart_on_error: If true, the Actor run process will be restarted whenever it exits with\n a non-zero status code.\n is_public: Whether the Actor is public.\n is_deprecated: Whether the Actor is deprecated.\n is_anonymously_runnable: Whether the Actor is anonymously runnable.\n categories: The categories to which the Actor belongs to.\n default_run_build: Tag or number of the build that you want to run by default.\n default_run_max_items: Default limit of the number of results that will be returned by runs\n of this Actor, if the Actor is charged per result.\n default_run_memory_mbytes: Default amount of memory allocated for the runs of this Actor, in megabytes.\n default_run_timeout_secs: Default timeout for the runs of this Actor in seconds.\n example_run_input_body: Input to be prefilled as default input to new users of this Actor.\n example_run_input_content_type: The content type of the example run input.\n actor_standby_is_enabled: Whether the Actor Standby is enabled.\n actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_max_requests_per_actor_run: The maximum number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_idle_timeout_secs: If the Actor run does not receive any requests for this time,\n it will be shut down.\n actor_standby_build: The build tag or number to run when the Actor is in Standby mode.\n actor_standby_memory_mbytes: The memory in megabytes to use when the Actor is in Standby mode.\n\nReturns:\n The created Actor." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 407, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor_collection.py", + "line": 170, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 604 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_collection.py#L170" } ], - "type": { - "name": "Annotated[str | None, Field(examples=['my-task'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 408, - "module": "_models", - "name": "options", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 605 - } - ], - "type": { - "name": "TaskOptions | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "TaskOptions", - "target": "1215" + "id": 1284, + "name": "create", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 409, - "module": "_models", - "name": "input", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 606 - } - ], - "type": { - "name": "TaskInput | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "TaskInput", - "target": "1213" + "type": { + "type": "intrinsic", + "name": "dict" }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 410, - "module": "_models", - "name": "title", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 607 + "parameters": [ + { + "id": 1285, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1286, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1287, + "name": "description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1288, + "name": "seo_title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1289, + "name": "seo_description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1290, + "name": "versions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1291, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1292, + "name": "is_public", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1293, + "name": "is_deprecated", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1294, + "name": "is_anonymously_runnable", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1295, + "name": "categories", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1296, + "name": "default_run_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1297, + "name": "default_run_max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1298, + "name": "default_run_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1299, + "name": "default_run_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1300, + "name": "example_run_input_body", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1301, + "name": "example_run_input_content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1302, + "name": "actor_standby_is_enabled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1303, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1304, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1305, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1306, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1307, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, + ] + } + ], + "groups": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 411, - "module": "_models", - "name": "actor_standby", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 608 - } - ], - "type": { - "name": "Annotated[ActorStandby | None, Field(alias='actorStandby')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorStandby", - "target": "255" - }, - { - "type": "literal", - "value": null - } - ] - } + "title": "Methods", + "children": [ + 1283, + 1276 + ] } ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor_collection.py", + "line": 138, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor_collection.py#L138" + } + ] + }, + { + "id": 1308, + "name": "get_actor_representation", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get dictionary representation of the Actor." } ] }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 406, - 411, - 409, - 405, - 407, - 408, - 410 - ], - "title": "Properties" - } - ], - "id": 404, - "module": "_models", - "name": "CreateTaskRequest", - "parsedDocstring": { - "text": "" - }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 35, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 598 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L35" } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, + "id": 1309, + "name": "get_actor_representation", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", "flags": {}, - "groups": [], - "id": 413, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 613 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Get dictionary representation of the Actor." } ] }, - "flags": {}, - "groups": [], - "id": 414, - "module": "_models", - "name": "monthly_usage_usd", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 617 - } - ], "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] + "type": "intrinsic", + "name": "dict" }, - "flags": {}, - "groups": [], - "id": 415, - "module": "_models", - "name": "monthly_actor_compute_units", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "parameters": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 618 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" + "id": 1310, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" } - ] - }, - "flags": {}, - "groups": [], - "id": 416, - "module": "_models", - "name": "monthly_external_data_transfer_gbytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ + }, { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 619 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 417, - "module": "_models", - "name": "monthly_proxy_serps", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "id": 1311, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 622 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 418, - "module": "_models", - "name": "monthly_residential_proxy_gbytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "id": 1312, + "name": "description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 623 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 419, - "module": "_models", - "name": "actor_memory_gbytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "id": 1313, + "name": "seo_title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 624 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 420, - "module": "_models", - "name": "actor_count", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "id": 1314, + "name": "seo_description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 625 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 421, - "module": "_models", - "name": "actor_task_count", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "id": 1315, + "name": "versions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 626 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 422, - "module": "_models", - "name": "active_actor_job_count", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "id": 1316, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 627 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 423, - "module": "_models", - "name": "team_account_seat_count", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "id": 1317, + "name": "is_public", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 628 + "id": 1318, + "name": "is_deprecated", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1319, + "name": "is_anonymously_runnable", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1320, + "name": "categories", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1321, + "name": "default_run_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1322, + "name": "default_run_max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1323, + "name": "default_run_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1324, + "name": "default_run_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1325, + "name": "default_run_force_permission_level", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorPermissionLevel | None" + }, + "defaultValue": "None" + }, + { + "id": 1326, + "name": "example_run_input_body", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1327, + "name": "example_run_input_content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1328, + "name": "actor_standby_is_enabled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1329, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1330, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1331, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1332, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1333, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1334, + "name": "pricing_infos", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1335, + "name": "actor_permission_level", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorPermissionLevel | None" + }, + "defaultValue": "None" + }, + { + "id": 1336, + "name": "tagged_builds", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict[str, None | dict[str, str]] | None" + }, + "defaultValue": "None" } - ], - "type": { - "name": "int", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 422, - 420, - 419, - 421, - 413, - 415, - 416, - 417, - 418, - 414, - 423 - ], - "title": "Properties" - } - ], - "id": 412, - "module": "_models", - "name": "Current", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 612 + ] } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 1337, + "name": "ActorClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 425, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 633 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 426, - "module": "_models", - "name": "pricing_model", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 637 - } - ], - "type": { - "name": "str", - "type": "reference" - } - } - ], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Sub-client for manipulating a single Actor." } ] }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 425, - 426 - ], - "title": "Properties" - } - ], - "id": 424, - "module": "_models", - "name": "CurrentPricingInfo", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 632 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1338, + "name": "get", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n\nReturns:\n The retrieved Actor." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 428, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 124, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 642 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L124" } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 429, - "module": "_models", - "name": "date", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 646 + "id": 1339, + "name": "get", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] } - ], - "type": { - "name": "str", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1340, + "name": "update", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n\nArgs:\n name: The name of the Actor.\n title: The title of the Actor (human-readable).\n description: The description for the Actor.\n seo_title: The title of the Actor optimized for search engines.\n seo_description: The description of the Actor optimized for search engines.\n versions: The list of Actor versions.\n restart_on_error: If true, the Actor run process will be restarted whenever it exits with\n a non-zero status code.\n is_public: Whether the Actor is public.\n is_deprecated: Whether the Actor is deprecated.\n is_anonymously_runnable: Whether the Actor is anonymously runnable.\n categories: The categories to which the Actor belongs to.\n default_run_build: Tag or number of the build that you want to run by default.\n default_run_max_items: Default limit of the number of results that will be returned\n by runs of this Actor, if the Actor is charged per result.\n default_run_memory_mbytes: Default amount of memory allocated for the runs of this Actor, in megabytes.\n default_run_timeout_secs: Default timeout for the runs of this Actor in seconds.\n example_run_input_body: Input to be prefilled as default input to new users of this Actor.\n example_run_input_content_type: The content type of the example run input.\n actor_standby_is_enabled: Whether the Actor Standby is enabled.\n actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_max_requests_per_actor_run: The maximum number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_idle_timeout_secs: If the Actor run does not receive any requests for this time,\n it will be shut down.\n actor_standby_build: The build tag or number to run when the Actor is in Standby mode.\n actor_standby_memory_mbytes: The memory in megabytes to use when the Actor is in Standby mode.\n pricing_infos: A list of objects that describes the pricing of the Actor.\n actor_permission_level: The permission level of the Actor on Apify platform.\n tagged_builds: A dictionary mapping build tag names to their settings. Use it to create, update,\n or remove build tags. To assign a tag, provide a dict with 'buildId' key. To remove a tag,\n set its value to None. Example: {'latest': {'buildId': 'abc'}, 'beta': None}.\n\nReturns:\n The updated Actor." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 430, - "module": "_models", - "name": "service_usage", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 134, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 647 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L134" } ], - "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" + "signatures": [ + { + "id": 1341, + "name": "update", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n\n" + } + ] }, - { - "type": "reference", - "name": "UsageItem", - "target": "1307" - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1342, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1343, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1344, + "name": "description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1345, + "name": "seo_title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1346, + "name": "seo_description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1347, + "name": "versions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1348, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1349, + "name": "is_public", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1350, + "name": "is_deprecated", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1351, + "name": "is_anonymously_runnable", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1352, + "name": "categories", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1353, + "name": "default_run_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1354, + "name": "default_run_max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1355, + "name": "default_run_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1356, + "name": "default_run_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1357, + "name": "example_run_input_body", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1358, + "name": "example_run_input_content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1359, + "name": "actor_standby_is_enabled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1360, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1361, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1362, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1363, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1364, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1365, + "name": "pricing_infos", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1366, + "name": "actor_permission_level", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorPermissionLevel | None" + }, + "defaultValue": "None" + }, + { + "id": 1367, + "name": "tagged_builds", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict[str, None | dict[str, str]] | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1368, + "name": "delete", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 431, - "module": "_models", - "name": "total_usage_credits_usd", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 237, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 648 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L237" } ], - "type": { - "name": "float", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 429, - 428, - 430, - 431 - ], - "title": "Properties" - } - ], - "id": 427, - "module": "_models", - "name": "DailyServiceUsages", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 641 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 433, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 653 + "id": 1369, + "name": "delete", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [] } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1370, + "name": "start", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n\nArgs:\n run_input: The input to pass to the Actor run.\n content_type: The content type of the input.\n build: Specifies the Actor build to run. It can be either a build tag or build number. By default,\n the run uses the build specified in the default run configuration for the Actor (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged\n per result, you will not be charged for more results than the given limit.\n max_total_charge_usd: A limit on the total charged amount for pay-per-event actors.\n restart_on_error: If true, the Actor run process will be restarted whenever it exits with\n a non-zero status code.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit\n specified in the default run configuration for the Actor.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the default run configuration for the Actor.\n force_permission_level: Override the Actor's permissions for this run. If not set, the Actor will run\n with permissions configured in the Actor settings.\n wait_for_finish: The maximum number of seconds the server waits for the run to finish. By default,\n it is 0, the maximum value is 60.\n webhooks: Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\n the Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\n If you already have a webhook set up for the Actor or task, you do not have to add it again here.\n Each webhook is represented by a dictionary containing these items:\n * `event_types`: List of `WebhookEventType` values which trigger the webhook.\n * `request_url`: URL to which to send the webhook HTTP request.\n * `payload_template`: Optional template for the request payload.\n\nReturns:\n The run object." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 434, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 244, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 657 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L244" } ], - "type": { - "name": "str", - "type": "reference" - } + "signatures": [ + { + "id": 1371, + "name": "start", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1372, + "name": "run_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1373, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1374, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1375, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1376, + "name": "max_total_charge_usd", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Decimal | None" + }, + "defaultValue": "None" + }, + { + "id": 1377, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1378, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1379, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1380, + "name": "force_permission_level", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorPermissionLevel | None" + }, + "defaultValue": "None" + }, + { + "id": 1381, + "name": "wait_for_finish", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1382, + "name": "webhooks", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1383, + "name": "call", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n\nArgs:\n run_input: The input to pass to the Actor run.\n content_type: The content type of the input.\n build: Specifies the Actor build to run. It can be either a build tag or build number. By default,\n the run uses the build specified in the default run configuration for the Actor (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged\n per result, you will not be charged for more results than the given limit.\n max_total_charge_usd: A limit on the total charged amount for pay-per-event actors.\n restart_on_error: If true, the Actor run process will be restarted whenever it exits with\n a non-zero status code.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit\n specified in the default run configuration for the Actor.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the default run configuration for the Actor.\n force_permission_level: Override the Actor's permissions for this run. If not set, the Actor will run\n with permissions configured in the Actor settings.\n webhooks: Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\n be used to receive a notification, e.g. when the Actor finished or failed. If you already have\n a webhook set up for the Actor, you do not have to add it again here.\n wait_secs: The maximum number of seconds the server waits for the run to finish. If not provided,\n waits indefinitely.\n logger: Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\n default logger will be used. Setting `None` will disable any log propagation. Passing custom logger\n will redirect logs to the provided logger. The logger is also used to capture status and status message\n of the other Actor run.\n\nReturns:\n The run object." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 435, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 316, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 658 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L316" } ], - "type": { - "name": "Annotated[str | None, Field(examples=['d7b9MDYsbtX5L7XAj'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 436, - "module": "_models", - "name": "user_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 659 + "id": 1384, + "name": "call", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [ + { + "id": 1385, + "name": "run_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1386, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1387, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1388, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1389, + "name": "max_total_charge_usd", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Decimal | None" + }, + "defaultValue": "None" + }, + { + "id": 1390, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1391, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1392, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1393, + "name": "webhooks", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1394, + "name": "force_permission_level", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorPermissionLevel | None" + }, + "defaultValue": "None" + }, + { + "id": 1395, + "name": "wait_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1396, + "name": "logger", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Logger | None | Literal['default']" + }, + "defaultValue": "'default'" + } + ] } - ], - "type": { - "name": "str", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1397, + "name": "build", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n\nArgs:\n version_number: Actor version number to be built.\n beta_packages: If True, then the Actor is built with beta versions of Apify NPM packages. By default,\n the build uses latest stable packages.\n tag: Tag to be applied to the build on success. By default, the tag is taken from the Actor version's\n build tag property.\n use_cache: If true, the Actor's Docker container will be rebuilt using layer cache\n (https://docs.docker.com/develop/develop-images/dockerfile_best-practices/`leverage`-build-cache).\n This is to enable quick rebuild during development. By default, the cache is not used.\n wait_for_finish: The maximum number of seconds the server waits for the build to finish before returning.\n By default it is 0, the maximum value is 60.\n\nReturns:\n The build object." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 437, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 390, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 660 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L390" } ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } + "signatures": [ + { + "id": 1398, + "name": "build", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1399, + "name": "version_number", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1400, + "name": "beta_packages", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1401, + "name": "tag", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1402, + "name": "use_cache", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1403, + "name": "wait_for_finish", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1404, + "name": "builds", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve a client for the builds of this Actor." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 438, - "module": "_models", - "name": "modified_at", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 434, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 661 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L434" } ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } + "signatures": [ + { + "id": 1405, + "name": "builds", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the builds of this Actor." + } + ] + }, + "type": { + "type": "reference", + "name": "BuildCollectionClient", + "id": 1093 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1406, + "name": "runs", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve a client for the runs of this Actor." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 439, - "module": "_models", - "name": "accessed_at", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 438, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 662 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L438" } ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } + "signatures": [ + { + "id": 1407, + "name": "runs", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this Actor." + } + ] + }, + "type": { + "type": "reference", + "name": "RunCollectionClient", + "id": 397 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1408, + "name": "default_build", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n\nArgs:\n wait_for_finish: The maximum number of seconds the server waits for the build to finish before returning.\n By default it is 0, the maximum value is 60.\n\nReturns:\n The resource client for the default build of this Actor." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 440, - "module": "_models", - "name": "item_count", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 442, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 663 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L442" } ], - "type": { - "name": "int", - "type": "reference" - } + "signatures": [ + { + "id": 1409, + "name": "default_build", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "BuildClient", + "id": 1105 + }, + "parameters": [ + { + "id": 1410, + "name": "wait_for_finish", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1411, + "name": "last_run", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n\nArgs:\n status: Consider only runs with this status.\n origin: Consider only runs started with this origin.\n\nReturns:\n The resource client for the last run of this Actor." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 441, - "module": "_models", - "name": "clean_item_count", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 472, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 664 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L472" } ], - "type": { - "name": "int", - "type": "reference" - } + "signatures": [ + { + "id": 1412, + "name": "last_run", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "RunClient", + "id": 415 + }, + "parameters": [ + { + "id": 1413, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorJobStatus | None" + }, + "defaultValue": "None" + }, + { + "id": 1414, + "name": "origin", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "MetaOrigin | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1415, + "name": "versions", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve a client for the versions of this Actor." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 442, - "module": "_models", - "name": "act_id", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 500, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 665 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L500" } ], - "type": { - "name": "Annotated[str | None, Field(alias='actId')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1416, + "name": "versions", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the versions of this Actor." + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "ActorVersionCollectionClient", + "id": 1133 }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1417, + "name": "version", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the client for the specified version of this Actor.\n\nArgs:\n version_number: The version number for which to retrieve the resource client.\n\nReturns:\n The resource client for the specified Actor version." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 443, - "module": "_models", - "name": "act_run_id", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 504, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 666 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L504" } ], - "type": { - "name": "Annotated[str | None, Field(alias='actRunId')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1418, + "name": "version", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified version of this Actor.\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "ActorVersionClient", + "id": 1161 }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 1419, + "name": "version_number", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1420, + "name": "webhooks", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve a client for webhooks associated with this Actor." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 444, - "module": "_models", - "name": "fields", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 515, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 667 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L515" } ], - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ + "signatures": [ + { + "id": 1421, + "name": "webhooks", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "reference", - "name": "str" + "kind": "text", + "text": "Retrieve a client for webhooks associated with this Actor." } - ], - "target": "2199" + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "reference", + "name": "WebhookCollectionClient", + "id": 30 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1422, + "name": "validate_input", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Defines the schema of items in your dataset, the full specification can be found in [Apify docs](/platform/actors/development/actor-definition/dataset-schema)" + "text": "Validate an input for the Actor that defines an input schema.\n\nArgs:\n run_input: The input to validate.\n build_tag: The actor's build tag.\n content_type: The content type of the input.\n\nReturns:\n True if the input is valid, else raise an exception with validation error details." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 445, - "module": "_models", - "name": "schema_", - "parsedDocstring": { - "text": "Defines the schema of items in your dataset, the full specification can be found in [Apify docs](/platform/actors/development/actor-definition/dataset-schema)" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 519, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 668 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L519" } ], - "type": { - "name": "Annotated[ dict[str, Any] | None, Field( alias='schema', examples=[ { 'actorSpecification': 1, 'title': 'My dataset', 'views': { 'overview': { 'title': 'Overview', 'transformation': {'fields': ['linkUrl']}, 'display': { 'component': 'table', 'properties': {'linkUrl': {'label': 'Link URL', 'format': 'link'}}, }, } }, } ], ), ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, + "signatures": [ + { + "id": 1423, + "name": "validate_input", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "reference", - "name": "Any" + "kind": "text", + "text": "Validate an input for the Actor that defines an input schema.\n\n" } ] }, - { - "type": "literal", - "value": null - } - ] + "type": { + "type": "intrinsic", + "name": "bool" + }, + "parameters": [ + { + "id": 1424, + "name": "run_input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1425, + "name": "build_tag", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1426, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1397, + 1404, + 1383, + 1408, + 1368, + 1338, + 1411, + 1406, + 1370, + 1340, + 1422, + 1417, + 1415, + 1420 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 117, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L117" + } + ] + }, + { + "id": 1427, + "name": "ActorClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async sub-client for manipulating a single Actor." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1428, + "name": "get", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n\nReturns:\n The retrieved Actor." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 446, - "module": "_models", - "name": "console_url", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 552, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 693 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L552" } ], - "type": { - "name": "AnyUrl", - "type": "reference" - } + "signatures": [ + { + "id": 1429, + "name": "get", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1430, + "name": "update", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A public link to access the dataset items directly." + "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n\nArgs:\n name: The name of the Actor.\n title: The title of the Actor (human-readable).\n description: The description for the Actor.\n seo_title: The title of the Actor optimized for search engines.\n seo_description: The description of the Actor optimized for search engines.\n versions: The list of Actor versions.\n restart_on_error: If true, the Actor run process will be restarted whenever it exits with\n a non-zero status code.\n is_public: Whether the Actor is public.\n is_deprecated: Whether the Actor is deprecated.\n is_anonymously_runnable: Whether the Actor is anonymously runnable.\n categories: The categories to which the Actor belongs to.\n default_run_build: Tag or number of the build that you want to run by default.\n default_run_max_items: Default limit of the number of results that will be returned\n by runs of this Actor, if the Actor is charged per result.\n default_run_memory_mbytes: Default amount of memory allocated for the runs of this Actor, in megabytes.\n default_run_timeout_secs: Default timeout for the runs of this Actor in seconds.\n example_run_input_body: Input to be prefilled as default input to new users of this Actor.\n example_run_input_content_type: The content type of the example run input.\n actor_standby_is_enabled: Whether the Actor Standby is enabled.\n actor_standby_desired_requests_per_actor_run: The desired number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_max_requests_per_actor_run: The maximum number of concurrent HTTP requests for\n a single Actor Standby run.\n actor_standby_idle_timeout_secs: If the Actor run does not receive any requests for this time,\n it will be shut down.\n actor_standby_build: The build tag or number to run when the Actor is in Standby mode.\n actor_standby_memory_mbytes: The memory in megabytes to use when the Actor is in Standby mode.\n pricing_infos: A list of objects that describes the pricing of the Actor.\n actor_permission_level: The permission level of the Actor on Apify platform.\n tagged_builds: A dictionary mapping build tag names to their settings. Use it to create, update,\n or remove build tags. To assign a tag, provide a dict with 'buildId' key. To remove a tag,\n set its value to None. Example: {'latest': {'buildId': 'abc'}, 'beta': None}.\n\nReturns:\n The updated Actor." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 447, - "module": "_models", - "name": "items_public_url", - "parsedDocstring": { - "text": "A public link to access the dataset items directly." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 562, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 696 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L562" } ], - "type": { - "name": "Annotated[ AnyUrl | None, Field( alias='itemsPublicUrl', examples=['https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items?signature=abc123'], ), ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AnyUrl" + "signatures": [ + { + "id": 1431, + "name": "update", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1432, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1433, + "name": "title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1434, + "name": "description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1435, + "name": "seo_title", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1436, + "name": "seo_description", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1437, + "name": "versions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1438, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1439, + "name": "is_public", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1440, + "name": "is_deprecated", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1441, + "name": "is_anonymously_runnable", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1442, + "name": "categories", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[str] | None" + }, + "defaultValue": "None" + }, + { + "id": 1443, + "name": "default_run_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1444, + "name": "default_run_max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1445, + "name": "default_run_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1446, + "name": "default_run_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1447, + "name": "example_run_input_body", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1448, + "name": "example_run_input_content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1449, + "name": "actor_standby_is_enabled", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1450, + "name": "actor_standby_desired_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1451, + "name": "actor_standby_max_requests_per_actor_run", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1452, + "name": "actor_standby_idle_timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1453, + "name": "actor_standby_build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1454, + "name": "actor_standby_memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1455, + "name": "pricing_infos", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1456, + "name": "actor_permission_level", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorPermissionLevel | None" + }, + "defaultValue": "None" + }, + { + "id": 1457, + "name": "tagged_builds", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict[str, None | dict[str, str]] | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1458, + "name": "delete", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the dataset." + "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor" } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 448, - "module": "_models", - "name": "url_signing_secret_key", - "parsedDocstring": { - "text": "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the dataset." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 665, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 706 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L665" } ], - "type": { - "name": "Annotated[str | None, Field(alias='urlSigningSecretKey')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1459, + "name": "delete", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1460, + "name": "start", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n\nArgs:\n run_input: The input to pass to the Actor run.\n content_type: The content type of the input.\n build: Specifies the Actor build to run. It can be either a build tag or build number. By default,\n the run uses the build specified in the default run configuration for the Actor (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged\n per result, you will not be charged for more results than the given limit.\n max_total_charge_usd: A limit on the total charged amount for pay-per-event actors.\n restart_on_error: If true, the Actor run process will be restarted whenever it exits with\n a non-zero status code.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit\n specified in the default run configuration for the Actor.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the default run configuration for the Actor.\n force_permission_level: Override the Actor's permissions for this run. If not set, the Actor will run\n with permissions configured in the Actor settings.\n wait_for_finish: The maximum number of seconds the server waits for the run to finish. By default,\n it is 0, the maximum value is 60.\n webhooks: Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\n the Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\n If you already have a webhook set up for the Actor or task, you do not have to add it again here.\n Each webhook is represented by a dictionary containing these items:\n * `event_types`: List of `WebhookEventType` values which trigger the webhook.\n * `request_url`: URL to which to send the webhook HTTP request.\n * `payload_template`: Optional template for the request payload.\n\nReturns:\n The run object." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 449, - "module": "_models", - "name": "general_access", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 672, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 710 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L672" } ], - "type": { - "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "GeneralAccess", - "target": "1797" - }, - { - "type": "literal", - "value": null - } - ] - } + "signatures": [ + { + "id": 1461, + "name": "start", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1462, + "name": "run_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1463, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1464, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1465, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1466, + "name": "max_total_charge_usd", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Decimal | None" + }, + "defaultValue": "None" + }, + { + "id": 1467, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1468, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1469, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1470, + "name": "force_permission_level", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorPermissionLevel | None" + }, + "defaultValue": "None" + }, + { + "id": 1471, + "name": "wait_for_finish", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1472, + "name": "webhooks", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1473, + "name": "call", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n\nArgs:\n run_input: The input to pass to the Actor run.\n content_type: The content type of the input.\n build: Specifies the Actor build to run. It can be either a build tag or build number. By default,\n the run uses the build specified in the default run configuration for the Actor (typically latest).\n max_items: Maximum number of results that will be returned by this run. If the Actor is charged\n per result, you will not be charged for more results than the given limit.\n max_total_charge_usd: A limit on the total charged amount for pay-per-event actors.\n restart_on_error: If true, the Actor run process will be restarted whenever it exits with\n a non-zero status code.\n memory_mbytes: Memory limit for the run, in megabytes. By default, the run uses a memory limit\n specified in the default run configuration for the Actor.\n timeout_secs: Optional timeout for the run, in seconds. By default, the run uses timeout specified\n in the default run configuration for the Actor.\n force_permission_level: Override the Actor's permissions for this run. If not set, the Actor will run\n with permissions configured in the Actor settings.\n webhooks: Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\n be used to receive a notification, e.g. when the Actor finished or failed. If you already have\n a webhook set up for the Actor, you do not have to add it again here.\n wait_secs: The maximum number of seconds the server waits for the run to finish. If not provided,\n waits indefinitely.\n logger: Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\n default logger will be used. Setting `None` will disable any log propagation. Passing custom logger\n will redirect logs to the provided logger. The logger is also used to capture status and status message\n of the other Actor run.\n\nReturns:\n The run object." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 450, - "module": "_models", - "name": "stats", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 744, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 711 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L744" } ], - "type": { - "name": "DatasetStats | None", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1474, + "name": "call", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "DatasetStats", - "target": "483" + "name": "dict | None" }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 439, - 442, - 443, - 441, - 446, - 437, - 444, - 449, - 434, - 440, - 447, - 433, - 438, - 435, - 445, - 450, - 448, - 436 - ], - "title": "Properties" - } - ], - "id": 432, - "module": "_models", - "name": "Dataset", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 652 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "parameters": [ + { + "id": 1475, + "name": "run_input", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1476, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1477, + "name": "build", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1478, + "name": "max_items", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1479, + "name": "max_total_charge_usd", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Decimal | None" + }, + "defaultValue": "None" + }, + { + "id": 1480, + "name": "restart_on_error", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1481, + "name": "memory_mbytes", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1482, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1483, + "name": "webhooks", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "list[dict] | None" + }, + "defaultValue": "None" + }, + { + "id": 1484, + "name": "force_permission_level", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorPermissionLevel | None" + }, + "defaultValue": "None" + }, + { + "id": 1485, + "name": "wait_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1486, + "name": "logger", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "Logger | None | Literal['default']" + }, + "defaultValue": "'default'" + } + ] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1487, + "name": "build", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n\nArgs:\n version_number: Actor version number to be built.\n beta_packages: If True, then the Actor is built with beta versions of Apify NPM packages. By default,\n the build uses latest stable packages.\n tag: Tag to be applied to the build on success. By default, the tag is taken from the Actor version's\n build tag property.\n use_cache: If true, the Actor's Docker container will be rebuilt using layer cache\n (https://docs.docker.com/develop/develop-images/dockerfile_best-practices/`leverage`-build-cache).\n This is to enable quick rebuild during development. By default, the cache is not used.\n wait_for_finish: The maximum number of seconds the server waits for the build to finish before returning.\n By default it is 0, the maximum value is 60.\n\nReturns:\n The build object." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 452, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 822, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 716 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L822" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 1488, + "name": "build", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "dict" + }, + "parameters": [ + { + "id": 1489, + "name": "version_number", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1490, + "name": "beta_packages", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1491, + "name": "tag", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1492, + "name": "use_cache", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "bool | None" + }, + "defaultValue": "None" + }, + { + "id": 1493, + "name": "wait_for_finish", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1494, + "name": "builds", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Minimum value of the field. For numbers, this is calculated directly. For strings, this is the length of the shortest string. For arrays, this is the length of the shortest array. For objects, this is the number of keys in the smallest object." + "text": "Retrieve a client for the builds of this Actor." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 453, - "module": "_models", - "name": "min", - "parsedDocstring": { - "text": "Minimum value of the field. For numbers, this is calculated directly. For strings, this is the length of the shortest string. For arrays, this is the length of the shortest array. For objects, this is the number of keys in the smallest object." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 866, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 720 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L866" } ], - "type": { - "name": "float | None", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1495, + "name": "builds", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the builds of this Actor." + } + ] + }, + "type": { "type": "reference", - "name": "float" + "name": "BuildCollectionClientAsync", + "id": 1099 }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1496, + "name": "runs", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Maximum value of the field. For numbers, this is calculated directly. For strings, this is the length of the longest string. For arrays, this is the length of the longest array. For objects, this is the number of keys in the largest object." + "text": "Retrieve a client for the runs of this Actor." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 454, - "module": "_models", - "name": "max", - "parsedDocstring": { - "text": "Maximum value of the field. For numbers, this is calculated directly. For strings, this is the length of the longest string. For arrays, this is the length of the longest array. For objects, this is the number of keys in the largest object." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 870, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 724 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L870" } ], - "type": { - "name": "float | None", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1497, + "name": "runs", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this Actor." + } + ] + }, + "type": { "type": "reference", - "name": "float" + "name": "RunCollectionClientAsync", + "id": 406 }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1498, + "name": "default_build", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "How many items in the dataset have a null value for this field." + "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n\nArgs:\n wait_for_finish: The maximum number of seconds the server waits for the build to finish before returning.\n By default it is 0, the maximum value is 60.\n\nReturns:\n The resource client for the default build of this Actor." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 455, - "module": "_models", - "name": "null_count", - "parsedDocstring": { - "text": "How many items in the dataset have a null value for this field." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 874, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 728 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L874" } ], - "type": { - "name": "Annotated[int | None, Field(alias='nullCount')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], + "signatures": [ + { + "id": 1499, + "name": "default_build", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "BuildClientAsync", + "id": 1119 + }, + "parameters": [ + { + "id": 1500, + "name": "wait_for_finish", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1501, + "name": "last_run", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "How many items in the dataset are `undefined`, meaning that for example empty string is not considered empty." + "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n\nArgs:\n status: Consider only runs with this status.\n origin: Consider only runs started with this origin.\n\nReturns:\n The resource client for the last run of this Actor." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 456, - "module": "_models", - "name": "empty_count", - "parsedDocstring": { - "text": "How many items in the dataset are `undefined`, meaning that for example empty string is not considered empty." - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 908, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 732 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L908" } ], - "type": { - "name": "Annotated[int | None, Field(alias='emptyCount')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1502, + "name": "last_run", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "int" + "name": "RunClientAsync", + "id": 468 }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 456, - 454, - 453, - 452, - 455 - ], - "title": "Properties" - } - ], - "id": 451, - "module": "_models", - "name": "DatasetFieldStatistics", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 715 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "parameters": [ + { + "id": 1503, + "name": "status", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ActorJobStatus | None" + }, + "defaultValue": "None" + }, + { + "id": 1504, + "name": "origin", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "MetaOrigin | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1505, + "name": "versions", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve a client for the versions of this Actor." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 458, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 936, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 740 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L936" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 1506, + "name": "versions", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the versions of this Actor." + } + ] + }, + "type": { + "type": "reference", + "name": "ActorVersionCollectionClientAsync", + "id": 1147 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1507, + "name": "version", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the client for the specified version of this Actor.\n\nArgs:\n version_number: The version number for which to retrieve the resource client.\n\nReturns:\n The resource client for the specified Actor version." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 459, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 940, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 744 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L940" } ], - "type": { - "name": "str", - "type": "reference" - } + "signatures": [ + { + "id": 1508, + "name": "version", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified version of this Actor.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ActorVersionClientAsync", + "id": 1181 + }, + "parameters": [ + { + "id": 1509, + "name": "version_number", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1510, + "name": "webhooks", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve a client for webhooks associated with this Actor." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 460, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 951, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 745 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L951" } ], - "type": { - "name": "str", - "type": "reference" - } + "signatures": [ + { + "id": 1511, + "name": "webhooks", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this Actor." + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookCollectionClientAsync", + "id": 49 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1512, + "name": "validate_input", + "module": "apify_client.clients.resource_clients.actor", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Validate an input for the Actor that defines an input schema.\n\nArgs:\n run_input: The input to validate.\n build_tag: The actor's build tag.\n content_type: The content type of the input.\n\nReturns:\n True if the input is valid, else raise an exception with validation error details." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 461, - "module": "_models", - "name": "user_id", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 955, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 746 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L955" } ], - "type": { - "name": "str", - "type": "reference" + "signatures": [ + { + "id": 1513, + "name": "validate_input", + "modifiers": [ + "async" + ], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Validate an input for the Actor that defines an input schema.\n\n" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "parameters": [ + { + "id": 1514, + "name": "run_input", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + }, + "defaultValue": "None" + }, + { + "id": 1515, + "name": "build_tag", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1516, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1487, + 1494, + 1473, + 1498, + 1458, + 1428, + 1501, + 1496, + 1460, + 1430, + 1512, + 1507, + 1505, + 1510 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/clients/resource_clients/actor.py", + "line": 545, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/resource_clients/actor.py#L545" + } + ] + }, + { + "id": 1517, + "name": "ListPage", + "module": "apify_client.clients.base.resource_collection_client", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A single page of items returned from a list() method." } - }, + ] + }, + "children": [ { + "id": 1518, + "name": "items", + "module": "apify_client.clients.base.resource_collection_client", "kind": 1024, "kindString": "Property", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List of returned objects on this page" } ] }, - "flags": {}, - "groups": [], - "id": 462, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "" + "type": { + "type": "reference", + "name": "list[T]" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 14, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 747 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L14" } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } + ] }, { + "id": 1519, + "name": "count", + "module": "apify_client.clients.base.resource_collection_client", "kind": 1024, "kindString": "Property", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Count of the returned objects on this page" } ] }, - "flags": {}, - "groups": [], - "id": 463, - "module": "_models", - "name": "modified_at", - "parsedDocstring": { - "text": "" + "type": { + "type": "intrinsic", + "name": "int" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 17, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 748 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L17" } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } + ] }, { + "id": 1520, + "name": "offset", + "module": "apify_client.clients.base.resource_collection_client", "kind": 1024, "kindString": "Property", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "The limit on the number of returned objects offset specified in the API call" } ] }, - "flags": {}, - "groups": [], - "id": 464, - "module": "_models", - "name": "accessed_at", - "parsedDocstring": { - "text": "" + "type": { + "type": "intrinsic", + "name": "int" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 20, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 749 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L20" } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } + ] }, { + "id": 1521, + "name": "limit", + "module": "apify_client.clients.base.resource_collection_client", "kind": 1024, "kindString": "Property", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "The offset of the first object specified in the API call" } ] }, - "flags": {}, - "groups": [], - "id": 465, - "module": "_models", - "name": "item_count", - "parsedDocstring": { - "text": "" + "type": { + "type": "intrinsic", + "name": "int" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 23, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 750 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L23" } - ], - "type": { - "name": "int", - "type": "reference" - } + ] }, { + "id": 1522, + "name": "total", + "module": "apify_client.clients.base.resource_collection_client", "kind": 1024, "kindString": "Property", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Total number of objects matching the API call criteria" } ] }, - "flags": {}, - "groups": [], - "id": 466, - "module": "_models", - "name": "clean_item_count", - "parsedDocstring": { - "text": "" + "type": { + "type": "intrinsic", + "name": "int" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 26, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 751 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L26" } - ], - "type": { - "name": "int", - "type": "reference" - } + ] }, { + "id": 1523, + "name": "desc", + "module": "apify_client.clients.base.resource_collection_client", "kind": 1024, "kindString": "Property", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Whether the listing is descending or not" } ] }, - "flags": {}, - "groups": [], - "id": 467, - "module": "_models", - "name": "act_id", - "parsedDocstring": { - "text": "" + "type": { + "type": "intrinsic", + "name": "bool" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 29, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 752 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L29" } - ], - "type": { - "name": "Annotated[str | None, Field(alias='actId', examples=['zdc3Pyhyz3m8vjDeM'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1524, + "name": "__init__", + "module": "apify_client.clients.base.resource_collection_client", + "kind": 512, + "kindString": "Constructor", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Initialize a ListPage instance from the API response data." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 468, - "module": "_models", - "name": "act_run_id", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 32, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 753 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L32" } ], - "type": { - "name": "Annotated[str | None, Field(alias='actRunId', examples=['HG7ML7M8z78YcAPEB'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1525, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a ListPage instance from the API response data." + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 1526, + "name": "data", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "dict" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1524 + ] + }, + { + "title": "Properties", + "children": [ + 1519, + 1523, + 1518, + 1521, + 1520, + 1522 + ] } ], + "sources": [ + { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 11, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L11" + } + ] + }, + { + "id": 1527, + "name": "ResourceCollectionClient", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Base class for sub-clients manipulating a resource collection." } ] }, - "decorations": [ + "children": [], + "groups": [], + "sources": [ { - "args": "('Models')", - "name": "docs_group" + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 42, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L42" } - ], + ] + }, + { + "id": 1528, + "name": "ResourceCollectionClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", "flags": {}, - "groups": [ - { - "children": [ - 464, - 467, - 468, - 466, - 462, - 459, - 465, - 458, - 463, - 460, - 461 - ], - "title": "Properties" - } - ], - "id": 457, - "module": "_models", - "name": "DatasetListItem", - "parsedDocstring": { - "text": "" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for async sub-clients manipulating a resource collection." + } + ] }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/clients/base/resource_collection_client.py", + "line": 75, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 739 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_collection_client.py#L75" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 1529, + "name": "ResourceClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 470, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 760 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 471, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 764 - } - ], - "type": { - "name": "Dataset", - "type": "reference", - "target": "432" - } - } - ], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Response containing dataset metadata." + "text": "Base class for sub-clients manipulating a single resource." } ] }, - "decorations": [ + "children": [], + "groups": [], + "sources": [ { - "args": "('Models')", - "name": "docs_group" + "filename": "/src/apify_client/clients/base/resource_client.py", + "line": 8, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_client.py#L8" } - ], + ] + }, + { + "id": 1530, + "name": "ResourceClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", "flags": {}, - "groups": [ - { - "children": [ - 471, - 470 - ], - "title": "Properties" - } - ], - "id": 469, - "module": "_models", - "name": "DatasetResponse", - "parsedDocstring": { - "text": "Response containing dataset metadata." + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for async sub-clients manipulating a single resource." + } + ] }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/clients/base/resource_client.py", + "line": 51, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 757 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/resource_client.py#L51" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 1531, + "name": "BaseClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for sub-clients." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, + "id": 1532, + "name": "__init__", + "module": "apify_client.clients.base.base_client", + "kind": 512, + "kindString": "Constructor", "flags": {}, - "groups": [], - "id": 473, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 769 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "The type of the error." + "text": "Initialize a new instance.\n\nArgs:\n base_url: Base URL of the API server.\n root_client: The ApifyClient instance under which this resource client exists.\n http_client: The HTTPClient instance to be used in this client.\n resource_id: ID of the manipulated resource, in case of a single-resource client.\n resource_path: Path to the resource's endpoint on the API server.\n params: Parameters to include in all requests from this client." } ] }, - "flags": {}, - "groups": [], - "id": 474, - "module": "_models", - "name": "type", - "parsedDocstring": { - "text": "The type of the error." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 773 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['schema-validation-error'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A human-readable message describing the error." - } - ] - }, - "flags": {}, "groups": [], - "id": 475, - "module": "_models", - "name": "message", - "parsedDocstring": { - "text": "A human-readable message describing the error." - }, "sources": [ { + "filename": "/src/apify_client/clients/base/base_client.py", + "line": 56, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 777 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/base_client.py#L56" } ], - "type": { - "name": "Annotated[str | None, Field(examples=['Schema validation failed'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 476, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 781 - } - ], - "type": { - "name": "SchemaValidationErrorData | None", - "type": "union", - "types": [ - { + "id": 1533, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "SchemaValidationErrorData", - "target": "1155" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + "parameters": [ + { + "id": 1534, + "name": "base_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1535, + "name": "root_client", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "ApifyClient", + "id": 1551 + } + }, + { + "id": 1536, + "name": "http_client", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "HTTPClient" + } + }, + { + "id": 1537, + "name": "resource_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1538, + "name": "resource_path", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1539, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Constructors", "children": [ - 476, - 475, - 473, - 474 - ], - "title": "Properties" + 1532 + ] } ], - "id": 472, - "module": "_models", - "name": "DatasetSchemaValidationError", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/base/base_client.py", + "line": 50, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 768 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/base_client.py#L50" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 1540, + "name": "BaseClientAsync", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for async sub-clients." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, + "id": 1541, + "name": "__init__", + "module": "apify_client.clients.base.base_client", + "kind": 512, + "kindString": "Constructor", "flags": {}, - "groups": [], - "id": 478, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 786 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "When you configure the dataset [fields schema](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation), we measure the statistics such as `min`, `max`, `nullCount` and `emptyCount` for each field. This property provides statistics for each field from dataset fields schema.

See dataset field statistics [documentation](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation#dataset-field-statistics) for more information." + "text": "Initialize a new instance.\n\nArgs:\n base_url: Base URL of the API server.\n root_client: The ApifyClientAsync instance under which this resource client exists.\n http_client: The HTTPClientAsync instance to be used in this client.\n resource_id: ID of the manipulated resource, in case of a single-resource client.\n resource_path: Path to the resource's endpoint on the API server.\n params: Parameters to include in all requests from this client." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 479, - "module": "_models", - "name": "field_statistics", - "parsedDocstring": { - "text": "When you configure the dataset [fields schema](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation), we measure the statistics such as `min`, `max`, `nullCount` and `emptyCount` for each field. This property provides statistics for each field from dataset fields schema.

See dataset field statistics [documentation](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation#dataset-field-statistics) for more information." - }, "sources": [ { + "filename": "/src/apify_client/clients/base/base_client.py", + "line": 97, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 790 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/base_client.py#L97" } ], - "type": { - "name": "Annotated[dict[str, Any] | None, Field(alias='fieldStatistics')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ + "signatures": [ + { + "id": 1542, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "reference", + "kind": "text", + "text": "Initialize a new instance.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 1543, + "name": "base_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", "name": "str" + } + }, + { + "id": 1544, + "name": "root_client", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" }, - { + "type": { "type": "reference", - "name": "Any" + "name": "ApifyClientAsync", + "id": 1620 } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + }, + { + "id": 1545, + "name": "http_client", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "HTTPClientAsync" + } + }, + { + "id": 1546, + "name": "resource_id", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1547, + "name": "resource_path", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1548, + "name": "params", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Constructors", "children": [ - 479, - 478 - ], - "title": "Properties" + 1541 + ] } ], - "id": 477, - "module": "_models", - "name": "DatasetStatistics", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/clients/base/base_client.py", + "line": 91, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 785 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/base_client.py#L91" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 1549, + "name": "ActorJobBaseClient", + "module": "apify_client.clients", "kind": 128, "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 481, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 798 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 482, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 802 - } - ], - "type": { - "name": "DatasetStatistics", - "type": "reference", - "target": "477" - } - } - ], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Base sub-client class for Actor runs and Actor builds." } ] }, - "decorations": [ + "children": [], + "groups": [], + "sources": [ { - "args": "('Models')", - "name": "docs_group" + "filename": "/src/apify_client/clients/base/actor_job_base_client.py", + "line": 20, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/actor_job_base_client.py#L20" } - ], + ] + }, + { + "id": 1550, + "name": "ActorJobBaseClientAsync", + "module": "apify_client.clients", + "kind": 128, + "kindString": "Class", "flags": {}, - "groups": [ - { - "children": [ - 482, - 481 - ], - "title": "Properties" - } - ], - "id": 480, - "module": "_models", - "name": "DatasetStatisticsResponse", - "parsedDocstring": { - "text": "" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base async sub-client class for Actor runs and Actor builds." + } + ] }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/clients/base/actor_job_base_client.py", + "line": 76, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 797 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/clients/base/actor_job_base_client.py#L76" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 1551, + "name": "ApifyClient", + "module": "apify_client", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Apify API client." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1552, + "name": "__init__", + "module": "apify_client.client", + "kind": 512, + "kindString": "Constructor", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Initialize a new instance.\n\nArgs:\n token: The Apify API token.\n api_url: The URL of the Apify API server to which to connect. Defaults to https://api.apify.com. It can\n be an internal URL that is not globally accessible, in such case `api_public_url` should be set as well.\n api_public_url: The globally accessible URL of the Apify API server. It should be set only if the `api_url`\n is an internal URL that is not globally accessible.\n max_retries: How many times to retry a failed request at most.\n min_delay_between_retries_millis: How long will the client wait between retrying requests\n (increases exponentially from this value).\n timeout_secs: The socket timeout of the HTTP requests sent to the Apify API.\n headers: Set headers to client for all requests." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 484, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 123, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 807 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L123" } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 485, - "module": "_models", - "name": "read_count", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 811 + "id": 1553, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 1554, + "name": "token", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1555, + "name": "api_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1556, + "name": "api_public_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1557, + "name": "max_retries", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "8" + }, + { + "id": 1558, + "name": "min_delay_between_retries_millis", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "500" + }, + { + "id": 1559, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "DEFAULT_TIMEOUT" + }, + { + "id": 1560, + "name": "headers", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + } + ] } - ], - "type": { - "name": "int", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1561, + "name": "actor", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating a single Actor.\n\nArgs:\n actor_id: ID of the Actor to be manipulated." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 486, - "module": "_models", - "name": "write_count", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 171, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 812 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L171" } ], - "type": { - "name": "int", - "type": "reference" - } + "signatures": [ + { + "id": 1562, + "name": "actor", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single Actor.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ActorClient", + "id": 1337 + }, + "parameters": [ + { + "id": 1563, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1564, + "name": "actors", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating Actors." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 487, - "module": "_models", - "name": "storage_bytes", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 179, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 813 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L179" } ], - "type": { - "name": "int", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 484, - 485, - 487, - 486 - ], - "title": "Properties" - } - ], - "id": 483, - "module": "_models", - "name": "DatasetStats", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 806 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ + { + "id": 1565, + "name": "actors", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating Actors." + } + ] + }, + "type": { + "type": "reference", + "name": "ActorCollectionClient", + "id": 1242 + }, + "parameters": [] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1566, + "name": "build", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating a single Actor build.\n\nArgs:\n build_id: ID of the Actor build to be manipulated." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 489, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 183, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 820 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L183" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 1567, + "name": "build", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single Actor build.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "BuildClient", + "id": 1105 + }, + "parameters": [ + { + "id": 1568, + "name": "build_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1569, + "name": "builds", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "ID of the default dataset for this run." + "text": "Retrieve the sub-client for querying multiple builds of a user." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 490, - "module": "_models", - "name": "default", - "parsedDocstring": { - "text": "ID of the default dataset for this run." - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 191, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 824 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L191" } ], - "type": { - "name": "Annotated[str | None, Field(examples=['wmKPijuyDnPZAPRMk'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1570, + "name": "builds", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple builds of a user." + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "BuildCollectionClient", + "id": 1093 }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Aliased dataset IDs for this run." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 490, - 489 - ], - "title": "Properties" - } - ], - "id": 488, - "module": "_models", - "name": "Datasets", - "parsedDocstring": { - "text": "Aliased dataset IDs for this run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 817 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "parameters": [] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1571, + "name": "run", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating a single Actor run.\n\nArgs:\n run_id: ID of the Actor run to be manipulated." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 492, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 195, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 832 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L195" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 1572, + "name": "run", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single Actor run.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "RunClient", + "id": 415 + }, + "parameters": [ + { + "id": 1573, + "name": "run_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1574, + "name": "runs", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The original object that was encoded." + "text": "Retrieve the sub-client for querying multiple Actor runs of a user." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 493, - "module": "_models", - "name": "decoded", - "parsedDocstring": { - "text": "The original object that was encoded." - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 203, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 836 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L203" } ], - "type": { - "name": "Any", - "type": "reference" - } + "signatures": [ + { + "id": 1575, + "name": "runs", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple Actor runs of a user." + } + ] + }, + "type": { + "type": "reference", + "name": "RunCollectionClient", + "id": 397 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1576, + "name": "dataset", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating a single dataset.\n\nArgs:\n dataset_id: ID of the dataset to be manipulated." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 494, - "module": "_models", - "name": "encoded_by_user_id", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 207, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 840 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L207" } ], - "type": { - "name": "Annotated[str | None, Field(alias='encodedByUserId', examples=['wRwJZtadYvn4mBZmm'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1577, + "name": "dataset", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single dataset.\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "DatasetClient", + "id": 892 }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 1578, + "name": "dataset_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1579, + "name": "datasets", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating datasets." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 495, - "module": "_models", - "name": "is_verified_user", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 215, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 841 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L215" } ], - "type": { - "name": "bool", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 493, - 494, - 495, - 492 - ], - "title": "Properties" - } - ], - "id": 491, - "module": "_models", - "name": "DecodeAndVerifyData", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 831 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ + { + "id": 1580, + "name": "datasets", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating datasets." + } + ] + }, + "type": { + "type": "reference", + "name": "DatasetCollectionClient", + "id": 870 + }, + "parameters": [] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1581, + "name": "key_value_store", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating a single key-value store.\n\nArgs:\n key_value_store_id: ID of the key-value store to be manipulated." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 497, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 219, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 846 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L219" } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 498, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ + "signatures": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 850 + "id": 1582, + "name": "key_value_store", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single key-value store.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "KeyValueStoreClient", + "id": 772 + }, + "parameters": [ + { + "id": 1583, + "name": "key_value_store_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] } - ], - "type": { - "name": "DecodeAndVerifyData", - "type": "reference", - "target": "491" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 498, - 497 - ], - "title": "Properties" - } - ], - "id": 496, - "module": "_models", - "name": "DecodeAndVerifyResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 845 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1584, + "name": "key_value_stores", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating key-value stores." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 500, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 227, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 855 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L227" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 1585, + "name": "key_value_stores", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating key-value stores." + } + ] + }, + "type": { + "type": "reference", + "name": "KeyValueStoreCollectionClient", + "id": 750 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1586, + "name": "request_queue", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating a single request queue.\n\nArgs:\n request_queue_id: ID of the request queue to be manipulated.\n client_key: A unique identifier of the client accessing the request queue." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 501, - "module": "_models", - "name": "build", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 231, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 859 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L231" } ], - "type": { - "name": "Annotated[str | None, Field(examples=['latest'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1587, + "name": "request_queue", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single request queue.\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "RequestQueueClient", + "id": 542 }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 1588, + "name": "request_queue_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1589, + "name": "client_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1590, + "name": "request_queues", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating request queues." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 502, - "module": "_models", - "name": "timeout_secs", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 240, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 860 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L240" } ], - "type": { - "name": "Annotated[int | None, Field(alias='timeoutSecs', examples=[3600])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1591, + "name": "request_queues", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating request queues." + } + ] + }, + "type": { "type": "reference", - "name": "int" + "name": "RequestQueueCollectionClient", + "id": 521 }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1592, + "name": "webhook", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating a single webhook.\n\nArgs:\n webhook_id: ID of the webhook to be manipulated." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 503, - "module": "_models", - "name": "memory_mbytes", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 244, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 861 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L244" } ], - "type": { - "name": "Annotated[int | None, Field(alias='memoryMbytes', examples=[2048])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1593, + "name": "webhook", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single webhook.\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "int" + "name": "WebhookClient", + "id": 81 }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 1594, + "name": "webhook_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1595, + "name": "webhooks", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for querying multiple webhooks of a user." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 504, - "module": "_models", - "name": "restart_on_error", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 252, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 862 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L252" } ], - "type": { - "name": "Annotated[bool | None, Field(alias='restartOnError', examples=[False])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1596, + "name": "webhooks", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple webhooks of a user." + } + ] + }, + "type": { "type": "reference", - "name": "bool" + "name": "WebhookCollectionClient", + "id": 30 }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1597, + "name": "webhook_dispatch", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for accessing a single webhook dispatch.\n\nArgs:\n webhook_dispatch_id: ID of the webhook dispatch to access." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 505, - "module": "_models", - "name": "max_items", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 256, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 863 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L256" } ], - "type": { - "name": "Annotated[int | None, Field(alias='maxItems')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1598, + "name": "webhook_dispatch", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for accessing a single webhook dispatch.\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "int" + "name": "WebhookDispatchClient", + "id": 24 }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 1599, + "name": "webhook_dispatch_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1600, + "name": "webhook_dispatches", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for querying multiple webhook dispatches of a user." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 506, - "module": "_models", - "name": "force_permission_level", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 264, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 864 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L264" } ], - "type": { - "name": "Annotated[ActorPermissionLevel | None, Field(alias='forcePermissionLevel')]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1601, + "name": "webhook_dispatches", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple webhook dispatches of a user." + } + ] + }, + "type": { "type": "reference", - "name": "ActorPermissionLevel", - "target": "1795" + "name": "WebhookDispatchCollectionClient", + "id": 12 }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 501, - 506, - 505, - 503, - 500, - 504, - 502 - ], - "title": "Properties" - } - ], - "id": 499, - "module": "_models", - "name": "DefaultRunOptions", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 854 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "parameters": [] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1602, + "name": "schedule", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating a single schedule.\n\nArgs:\n schedule_id: ID of the schedule to be manipulated." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 508, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 268, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 871 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L268" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 1603, + "name": "schedule", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single schedule.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ScheduleClient", + "id": 363 + }, + "parameters": [ + { + "id": 1604, + "name": "schedule_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1605, + "name": "schedules", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + "text": "Retrieve the sub-client for manipulating schedules." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 509, - "module": "_models", - "name": "unique_key", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 276, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 875 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L276" } ], - "type": { - "name": "Annotated[ str | None, Field(alias='uniqueKey', examples=['GET|60d83e70|e3b0c442|https://apify.com']) ]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1606, + "name": "schedules", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating schedules." + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "ScheduleCollectionClient", + "id": 331 }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1607, + "name": "log", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique identifier assigned to the request." + "text": "Retrieve the sub-client for retrieving logs.\n\nArgs:\n build_or_run_id: ID of the Actor build or run for which to access the log." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 510, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request." - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 280, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 881 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L280" } ], - "type": { - "name": "str", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Confirmation of a request that was successfully deleted, identified by its ID." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 510, - 508, - 509 - ], - "title": "Properties" - } - ], - "id": 507, - "module": "_models", - "name": "DeletedRequestById", - "parsedDocstring": { - "text": "Confirmation of a request that was successfully deleted, identified by its ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 868 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ + { + "id": 1608, + "name": "log", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for retrieving logs.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "LogClient", + "id": 662 + }, + "parameters": [ + { + "id": 1609, + "name": "build_or_run_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1610, + "name": "task", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating a single task.\n\nArgs:\n task_id: ID of the task to be manipulated." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 512, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 288, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 891 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L288" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 1611, + "name": "task", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single task.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "TaskClient", + "id": 205 + }, + "parameters": [ + { + "id": 1612, + "name": "task_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1613, + "name": "tasks", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + "text": "Retrieve the sub-client for manipulating tasks." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 513, - "module": "_models", - "name": "unique_key", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 296, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 895 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L296" } ], - "type": { - "name": "str", - "type": "reference" - } + "signatures": [ + { + "id": 1614, + "name": "tasks", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating tasks." + } + ] + }, + "type": { + "type": "reference", + "name": "TaskCollectionClient", + "id": 145 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1615, + "name": "user", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique identifier assigned to the request." + "text": "Retrieve the sub-client for querying users.\n\nArgs:\n user_id: ID of user to be queried. If None, queries the user belonging to the token supplied to the client." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 514, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request." - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 300, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 899 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L300" } ], - "type": { - "name": "Annotated[str | None, Field(examples=['sbJ7klsdf7ujN9l'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1616, + "name": "user", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying users.\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "UserClient", + "id": 123 }, + "parameters": [ + { + "id": 1617, + "name": "user_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1618, + "name": "store", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Retrieve the sub-client for Apify store." } ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Confirmation of a request that was successfully deleted, identified by its unique key." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 308, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L308" + } + ], + "signatures": [ + { + "id": 1619, + "name": "store", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for Apify store." + } + ] + }, + "type": { + "type": "reference", + "name": "StoreCollectionClient", + "id": 311 + }, + "parameters": [] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Constructors", "children": [ - 514, - 512, - 513 - ], - "title": "Properties" + 1552 + ] + }, + { + "title": "Methods", + "children": [ + 1561, + 1564, + 1566, + 1569, + 1576, + 1579, + 1581, + 1584, + 1607, + 1586, + 1590, + 1571, + 1574, + 1602, + 1605, + 1618, + 1610, + 1613, + 1615, + 1592, + 1597, + 1600, + 1595 + ] } ], - "id": 511, - "module": "_models", - "name": "DeletedRequestByUniqueKey", - "parsedDocstring": { - "text": "Confirmation of a request that was successfully deleted, identified by its unique key." - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 118, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 888 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L118" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 1620, + "name": "ApifyClientAsync", + "module": "apify_client", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The asynchronous version of the Apify API client." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1621, + "name": "__init__", + "module": "apify_client.client", + "kind": 512, + "kindString": "Constructor", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Initialize a new instance.\n\nArgs:\n token: The Apify API token.\n api_url: The URL of the Apify API server to which to connect. Defaults to https://api.apify.com. It can\n be an internal URL that is not globally accessible, in such case `api_public_url` should be set as well.\n api_public_url: The globally accessible URL of the Apify API server. It should be set only if the `api_url`\n is an internal URL that is not globally accessible.\n max_retries: How many times to retry a failed request at most.\n min_delay_between_retries_millis: How long will the client wait between retrying requests\n (increases exponentially from this value).\n timeout_secs: The socket timeout of the HTTP requests sent to the Apify API.\n headers: Set headers to client for all requests." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 516, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 318, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 907 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L318" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 1622, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 1623, + "name": "token", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1624, + "name": "api_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1625, + "name": "api_public_url", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + }, + { + "id": 1626, + "name": "max_retries", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "8" + }, + { + "id": 1627, + "name": "min_delay_between_retries_millis", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "500" + }, + { + "id": 1628, + "name": "timeout_secs", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "DEFAULT_TIMEOUT" + }, + { + "id": 1629, + "name": "headers", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "dict | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1630, + "name": "actor", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating a single Actor.\n\nArgs:\n actor_id: ID of the Actor to be manipulated." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 517, - "module": "_models", - "name": "is_enabled", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 366, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 911 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L366" } ], - "type": { - "name": "bool", - "type": "reference" - } + "signatures": [ + { + "id": 1631, + "name": "actor", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single Actor.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ActorClientAsync", + "id": 1427 + }, + "parameters": [ + { + "id": 1632, + "name": "actor_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1633, + "name": "actors", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating Actors." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 518, - "module": "_models", - "name": "disabled_reason", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 374, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 912 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L374" } ], - "type": { - "name": "Annotated[ str | None, Field( alias='disabledReason', examples=[ 'The \"Selected public Actors for developers\" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com' ], ), ]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1634, + "name": "actors", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating Actors." + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "ActorCollectionClientAsync", + "id": 1275 }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1635, + "name": "build", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating a single Actor build.\n\nArgs:\n build_id: ID of the Actor build to be manipulated." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 519, - "module": "_models", - "name": "disabled_reason_type", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 378, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 921 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L378" } ], - "type": { - "name": "Annotated[str | None, Field(alias='disabledReasonType', examples=['DISABLED'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1636, + "name": "build", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single Actor build.\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "BuildClientAsync", + "id": 1119 }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 1637, + "name": "build_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1638, + "name": "builds", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for querying multiple builds of a user." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 520, - "module": "_models", - "name": "is_trial", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 386, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 922 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L386" } ], - "type": { - "name": "bool", - "type": "reference" - } + "signatures": [ + { + "id": 1639, + "name": "builds", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple builds of a user." + } + ] + }, + "type": { + "type": "reference", + "name": "BuildCollectionClientAsync", + "id": 1099 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1640, + "name": "run", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating a single Actor run.\n\nArgs:\n run_id: ID of the Actor run to be manipulated." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 521, - "module": "_models", - "name": "trial_expiration_at", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 390, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 923 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L390" } ], - "type": { - "name": "Annotated[ AwareDatetime | None, Field(alias='trialExpirationAt', examples=['2025-01-01T14:00:00.000Z']) ]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1641, + "name": "run", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single Actor run.\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "AwareDatetime" + "name": "RunClientAsync", + "id": 468 }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 518, - 519, - 517, - 520, - 516, - 521 - ], - "title": "Properties" - } - ], - "id": 515, - "module": "_models", - "name": "EffectivePlatformFeature", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 906 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "parameters": [ + { + "id": 1642, + "name": "run_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1643, + "name": "runs", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for querying multiple Actor runs of a user." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 523, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 398, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 930 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L398" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 1644, + "name": "runs", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple Actor runs of a user." + } + ] + }, + "type": { + "type": "reference", + "name": "RunCollectionClientAsync", + "id": 406 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1645, + "name": "dataset", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating a single dataset.\n\nArgs:\n dataset_id: ID of the dataset to be manipulated." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 524, - "module": "_models", - "name": "actors", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 402, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 934 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L402" } ], - "type": { - "name": "EffectivePlatformFeature", - "type": "reference", - "target": "515" - } + "signatures": [ + { + "id": 1646, + "name": "dataset", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single dataset.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "DatasetClientAsync", + "id": 1002 + }, + "parameters": [ + { + "id": 1647, + "name": "dataset_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1648, + "name": "datasets", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating datasets." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 525, - "module": "_models", - "name": "storage", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 410, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 935 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L410" } ], - "type": { - "name": "EffectivePlatformFeature", - "type": "reference", - "target": "515" - } + "signatures": [ + { + "id": 1649, + "name": "datasets", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating datasets." + } + ] + }, + "type": { + "type": "reference", + "name": "DatasetCollectionClientAsync", + "id": 881 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1650, + "name": "key_value_store", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating a single key-value store.\n\nArgs:\n key_value_store_id: ID of the key-value store to be manipulated." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 526, - "module": "_models", - "name": "scheduler", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 414, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 936 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L414" } ], - "type": { - "name": "EffectivePlatformFeature", - "type": "reference", - "target": "515" - } + "signatures": [ + { + "id": 1651, + "name": "key_value_store", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single key-value store.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "KeyValueStoreClientAsync", + "id": 821 + }, + "parameters": [ + { + "id": 1652, + "name": "key_value_store_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1653, + "name": "key_value_stores", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating key-value stores." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 527, - "module": "_models", - "name": "proxy", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 422, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 937 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L422" } ], - "type": { - "name": "EffectivePlatformFeature", - "type": "reference", - "target": "515" - } + "signatures": [ + { + "id": 1654, + "name": "key_value_stores", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating key-value stores." + } + ] + }, + "type": { + "type": "reference", + "name": "KeyValueStoreCollectionClientAsync", + "id": 761 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1655, + "name": "request_queue", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating a single request queue.\n\nArgs:\n request_queue_id: ID of the request queue to be manipulated.\n client_key: A unique identifier of the client accessing the request queue." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 528, - "module": "_models", - "name": "proxy_external_access", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 426, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 938 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L426" } ], - "type": { - "name": "EffectivePlatformFeature", - "type": "reference", - "target": "515" - } + "signatures": [ + { + "id": 1656, + "name": "request_queue", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single request queue.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "RequestQueueClientAsync", + "id": 602 + }, + "parameters": [ + { + "id": 1657, + "name": "request_queue_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1658, + "name": "client_key", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1659, + "name": "request_queues", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating request queues." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 529, - "module": "_models", - "name": "proxy_residential", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 435, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 939 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L435" } ], - "type": { - "name": "EffectivePlatformFeature", - "type": "reference", - "target": "515" - } + "signatures": [ + { + "id": 1660, + "name": "request_queues", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating request queues." + } + ] + }, + "type": { + "type": "reference", + "name": "RequestQueueCollectionClientAsync", + "id": 531 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1661, + "name": "webhook", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating a single webhook.\n\nArgs:\n webhook_id: ID of the webhook to be manipulated." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 530, - "module": "_models", - "name": "proxy_serps", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 439, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 940 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L439" } ], - "type": { - "name": "EffectivePlatformFeature", - "type": "reference", - "target": "515" - } + "signatures": [ + { + "id": 1662, + "name": "webhook", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single webhook.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookClientAsync", + "id": 102 + }, + "parameters": [ + { + "id": 1663, + "name": "webhook_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1664, + "name": "webhooks", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for querying multiple webhooks of a user." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 531, - "module": "_models", - "name": "webhooks", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 447, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 941 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L447" } ], - "type": { - "name": "EffectivePlatformFeature", - "type": "reference", - "target": "515" - } + "signatures": [ + { + "id": 1665, + "name": "webhooks", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple webhooks of a user." + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookCollectionClientAsync", + "id": 49 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1666, + "name": "webhook_dispatch", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for accessing a single webhook dispatch.\n\nArgs:\n webhook_dispatch_id: ID of the webhook dispatch to access." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 532, - "module": "_models", - "name": "actors_public_all", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 451, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 942 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L451" } ], - "type": { - "name": "EffectivePlatformFeature", - "type": "reference", - "target": "515" - } + "signatures": [ + { + "id": 1667, + "name": "webhook_dispatch", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for accessing a single webhook dispatch.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookDispatchClientAsync", + "id": 27 + }, + "parameters": [ + { + "id": 1668, + "name": "webhook_dispatch_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1669, + "name": "webhook_dispatches", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for querying multiple webhook dispatches of a user." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 533, - "module": "_models", - "name": "actors_public_developer", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 459, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 943 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L459" } ], - "type": { - "name": "EffectivePlatformFeature", - "type": "reference", - "target": "515" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ + "signatures": [ + { + "id": 1670, + "name": "webhook_dispatches", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple webhook dispatches of a user." + } + ] + }, + "type": { + "type": "reference", + "name": "WebhookDispatchCollectionClientAsync", + "id": 18 + }, + "parameters": [] + } + ] + }, { - "children": [ - 524, - 532, - 533, - 523, - 527, - 528, - 529, - 530, - 526, - 525, - 531 + "id": 1671, + "name": "schedule", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single schedule.\n\nArgs:\n schedule_id: ID of the schedule to be manipulated." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 463, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L463" + } ], - "title": "Properties" - } - ], - "id": 522, - "module": "_models", - "name": "EffectivePlatformFeatures", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 929 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ + { + "id": 1672, + "name": "schedule", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single schedule.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "ScheduleClientAsync", + "id": 380 + }, + "parameters": [ + { + "id": 1673, + "name": "schedule_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1674, + "name": "schedules", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating schedules." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 535, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 471, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 948 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L471" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 1675, + "name": "schedules", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating schedules." + } + ] + }, + "type": { + "type": "reference", + "name": "ScheduleCollectionClientAsync", + "id": 347 + }, + "parameters": [] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1676, + "name": "log", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for retrieving logs.\n\nArgs:\n build_or_run_id: ID of the Actor build or run for which to access the log." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 536, - "module": "_models", - "name": "encoded", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 475, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 952 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L475" } ], - "type": { - "name": "str", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 536, - 535 - ], - "title": "Properties" - } - ], - "id": 534, - "module": "_models", - "name": "EncodeAndSignData", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 947 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "DecodeAndVerifyRequest", - "target": "537", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ + { + "id": 1677, + "name": "log", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for retrieving logs.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "LogClientAsync", + "id": 672 + }, + "parameters": [ + { + "id": 1678, + "name": "build_or_run_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1679, + "name": "task", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating a single task.\n\nArgs:\n task_id: ID of the task to be manipulated." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 4143, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 483, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 948 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L483" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "inheritedFrom": { - "name": "EncodeAndSignData.model_config", - "target": 535, - "type": "reference" - } + "signatures": [ + { + "id": 1680, + "name": "task", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single task.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "TaskClientAsync", + "id": 258 + }, + "parameters": [ + { + "id": 1681, + "name": "task_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1682, + "name": "tasks", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for manipulating tasks." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 4144, - "module": "_models", - "name": "encoded", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 491, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 952 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L491" } ], - "type": { - "name": "str", - "type": "reference" - }, - "inheritedFrom": { - "name": "EncodeAndSignData.encoded", - "target": 536, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4144, - 4143 - ], - "title": "Properties" - } - ], - "id": 537, - "module": "_models", - "name": "DecodeAndVerifyRequest", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 956 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "EncodeAndSignData", - "target": "534", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ + { + "id": 1683, + "name": "tasks", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating tasks." + } + ] + }, + "type": { + "type": "reference", + "name": "TaskCollectionClientAsync", + "id": 167 + }, + "parameters": [] + } + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1684, + "name": "user", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for querying users.\n\nArgs:\n user_id: ID of user to be queried. If None, queries the user belonging to the token supplied to the client." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 539, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 495, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 962 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L495" } ], - "type": { - "name": "Undefined", - "type": "reference" - } + "signatures": [ + { + "id": 1685, + "name": "user", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying users.\n\n" + } + ] + }, + "type": { + "type": "reference", + "name": "UserClientAsync", + "id": 134 + }, + "parameters": [ + { + "id": 1686, + "name": "user_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "str | None" + }, + "defaultValue": "None" + } + ] + } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1687, + "name": "store", + "module": "apify_client.client", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Retrieve the sub-client for Apify store." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 540, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/client.py", + "line": 503, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 966 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L503" } ], - "type": { - "name": "EncodeAndSignData", - "type": "reference", - "target": "534" - } + "signatures": [ + { + "id": 1688, + "name": "store", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for Apify store." + } + ] + }, + "type": { + "type": "reference", + "name": "StoreCollectionClientAsync", + "id": 321 + }, + "parameters": [] + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1621 + ] + }, + { + "title": "Methods", + "children": [ + 1630, + 1633, + 1635, + 1638, + 1645, + 1648, + 1650, + 1653, + 1676, + 1655, + 1659, + 1640, + 1643, + 1671, + 1674, + 1687, + 1679, + 1682, + 1684, + 1661, + 1666, + 1669, + 1664 + ] } ], + "sources": [ + { + "filename": "/src/apify_client/client.py", + "line": 313, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/client.py#L313" + } + ] + }, + { + "id": 1689, + "name": "filter_out_none_values_recursively", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Return copy of the dictionary, recursively omitting all keys for which values are None." } ] }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 540, - 539 - ], - "title": "Properties" - } - ], - "id": 538, - "module": "_models", - "name": "EncodeAndSignResponse", - "parsedDocstring": { - "text": "" - }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/_utils.py", + "line": 37, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 961 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L37" } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1690, + "name": "filter_out_none_values_recursively", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Return copy of the dictionary, recursively omitting all keys for which values are None." } ] }, - "flags": {}, - "groups": [], - "id": 542, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "intrinsic", + "name": "dict" }, - "sources": [ + "parameters": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 971 + "id": 1691, + "name": "dictionary", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "dict" + } } - ], - "type": { - "name": "Undefined", - "type": "reference" + ] + } + ] + }, + { + "id": 1692, + "name": "filter_out_none_values_recursively_internal", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Recursively filters out None values from a dictionary.\n\nUnfortunately, it's necessary to have an internal function for the correct result typing,\nwithout having to create complicated overloads" } - }, + ] + }, + "children": [], + "groups": [], + "sources": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "filename": "/src/apify_client/_utils.py", + "line": 42, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L42" + } + ], + "signatures": [ + { + "id": 1693, + "name": "filter_out_none_values_recursively_internal", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Recursively filters out None values from a dictionary.\n\nUnfortunately, it's necessary to have an internal function for the correct result typing,\nwithout having to create complicated overloads" } ] }, - "flags": {}, - "groups": [], - "id": 543, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" + "type": { + "type": "reference", + "name": "dict | None" }, - "sources": [ + "parameters": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 975 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The environment variable value. This field is absent in responses when `isSecret` is `true`, as secret values are never returned by the API." + "id": 1694, + "name": "dictionary", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "dict" } - ] - }, - "flags": {}, - "groups": [], - "id": 544, - "module": "_models", - "name": "value", - "parsedDocstring": { - "text": "The environment variable value. This field is absent in responses when `isSecret` is `true`, as secret values are never returned by the API." - }, - "sources": [ + }, { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 976 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['my-value'])]", - "type": "union", - "types": [ - { + "id": 1695, + "name": "remove_empty_dicts", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "keyword-only": "true" + }, + "type": { "type": "reference", - "name": "str" + "name": "bool | None" }, - { - "type": "literal", - "value": null - } - ] + "defaultValue": "None" + } + ] + } + ] + }, + { + "id": 1696, + "name": "parse_date_fields", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Recursively parse date fields in a list or dictionary up to the specified depth." } - }, + ] + }, + "children": [], + "groups": [], + "sources": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "filename": "/src/apify_client/_utils.py", + "line": 73, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L73" + } + ], + "signatures": [ + { + "id": 1697, + "name": "parse_date_fields", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Recursively parse date fields in a list or dictionary up to the specified depth." } ] }, - "flags": {}, - "groups": [], - "id": 545, - "module": "_models", - "name": "is_secret", - "parsedDocstring": { - "text": "" + "type": { + "type": "reference", + "name": "list | dict" }, - "sources": [ + "parameters": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 980 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='isSecret', examples=[False])]", - "type": "union", - "types": [ - { + "id": 1698, + "name": "data", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null + "name": "list | dict" } - ] - } + }, + { + "id": 1699, + "name": "max_depth", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "int" + }, + "defaultValue": "PARSE_DATE_FIELDS_MAX_DEPTH" + } + ] } - ], + ] + }, + { + "id": 1700, + "name": "is_content_type_json", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Check if the given content type is JSON." } ] }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 545, - 542, - 543, - 544 - ], - "title": "Properties" - } - ], - "id": 541, - "module": "_models", - "name": "EnvVar", - "parsedDocstring": { - "text": "" - }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/_utils.py", + "line": 99, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 970 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L99" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "EnvVarRequest", - "target": "546", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1701, + "name": "is_content_type_json", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Check if the given content type is JSON." } ] }, - "flags": {}, - "groups": [], - "id": 547, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "intrinsic", + "name": "bool" }, - "sources": [ + "parameters": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 985 + "id": 1702, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "EnvVar.model_config", - "target": 542, - "type": "reference" + ] + } + ] + }, + { + "id": 1703, + "name": "is_content_type_xml", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if the given content type is XML." } - }, + ] + }, + "children": [], + "groups": [], + "sources": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "filename": "/src/apify_client/_utils.py", + "line": 104, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L104" + } + ], + "signatures": [ + { + "id": 1704, + "name": "is_content_type_xml", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Check if the given content type is XML." } ] }, - "flags": {}, - "groups": [], - "id": 4140, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" + "type": { + "type": "intrinsic", + "name": "bool" }, - "sources": [ + "parameters": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 975 + "id": 1705, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } } - ], - "type": { - "name": "str", - "type": "reference" - }, - "inheritedFrom": { - "name": "EnvVar.name", - "target": 543, - "type": "reference" + ] + } + ] + }, + { + "id": 1706, + "name": "is_content_type_text", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if the given content type is text." } - }, + ] + }, + "children": [], + "groups": [], + "sources": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "filename": "/src/apify_client/_utils.py", + "line": 109, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L109" + } + ], + "signatures": [ + { + "id": 1707, + "name": "is_content_type_text", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The environment variable value. This field is absent in responses when `isSecret` is `true`, as secret values are never returned by the API." + "text": "Check if the given content type is text." } ] }, - "flags": {}, - "groups": [], - "id": 4141, - "module": "_models", - "name": "value", - "parsedDocstring": { - "text": "The environment variable value. This field is absent in responses when `isSecret` is `true`, as secret values are never returned by the API." + "type": { + "type": "intrinsic", + "name": "bool" }, - "sources": [ + "parameters": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 976 + "id": 1708, + "name": "content_type", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['my-value'])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "EnvVar.value", - "target": 544, - "type": "reference" + ] + } + ] + }, + { + "id": 1709, + "name": "is_file_or_bytes", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if the input value is a file-like object or bytes.\n\nThe check for IOBase is not ideal, it would be better to use duck typing,\nbut then the check would be super complex, judging from how the 'requests' library does it.\nThis way should be good enough for the vast majority of use cases, if it causes issues, we can improve it later." } - }, + ] + }, + "children": [], + "groups": [], + "sources": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "filename": "/src/apify_client/_utils.py", + "line": 114, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L114" + } + ], + "signatures": [ + { + "id": 1710, + "name": "is_file_or_bytes", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Check if the input value is a file-like object or bytes.\n\nThe check for IOBase is not ideal, it would be better to use duck typing,\nbut then the check would be super complex, judging from how the 'requests' library does it.\nThis way should be good enough for the vast majority of use cases, if it causes issues, we can improve it later." } ] }, - "flags": {}, - "groups": [], - "id": 4142, - "module": "_models", - "name": "is_secret", - "parsedDocstring": { - "text": "" + "type": { + "type": "intrinsic", + "name": "bool" }, - "sources": [ + "parameters": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 980 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='isSecret', examples=[False])]", - "type": "union", - "types": [ - { + "id": 1711, + "name": "value", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null + "name": "Any" } - ] - }, - "inheritedFrom": { - "name": "EnvVar.is_secret", - "target": 545, - "type": "reference" - } + } + ] } - ], + ] + }, + { + "id": 1712, + "name": "json_dumps", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Dump JSON to a string with the correct settings and serializer." } ] }, - "decorations": [ + "children": [], + "groups": [], + "sources": [ { - "args": "('Models')", - "name": "docs_group" + "filename": "/src/apify_client/_utils.py", + "line": 124, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L124" } ], - "flags": {}, - "groups": [ + "signatures": [ { - "children": [ - 4142, - 547, - 4140, - 4141 - ], - "title": "Properties" + "id": 1713, + "name": "json_dumps", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dump JSON to a string with the correct settings and serializer." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 1714, + "name": "obj", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + } + } + ] } - ], - "id": 546, - "module": "_models", - "name": "EnvVarRequest", - "parsedDocstring": { - "text": "" + ] + }, + { + "id": 1715, + "name": "maybe_extract_enum_member_value", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Extract the value of an enumeration member if it is an Enum, otherwise return the original value." + } + ] }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/_utils.py", + "line": 129, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 984 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L129" } ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "EnvVar", - "target": "541", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1716, + "name": "maybe_extract_enum_member_value", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Extract the value of an enumeration member if it is an Enum, otherwise return the original value." } ] }, - "flags": {}, - "groups": [], - "id": 549, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "reference", + "name": "Any" }, - "sources": [ + "parameters": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 993 + "id": 1717, + "name": "maybe_enum_member", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Any" + } } - ], - "type": { - "name": "Undefined", - "type": "reference" + ] + } + ] + }, + { + "id": 1718, + "name": "encode_webhook_list_to_base64", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Encode a list of dictionaries representing webhooks to their base64-encoded representation for the API." } - }, + ] + }, + "children": [], + "groups": [], + "sources": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "filename": "/src/apify_client/_utils.py", + "line": 230, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L230" + } + ], + "signatures": [ + { + "id": 1719, + "name": "encode_webhook_list_to_base64", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Encode a list of dictionaries representing webhooks to their base64-encoded representation for the API." } ] }, - "flags": {}, - "groups": [], - "id": 550, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" + "type": { + "type": "intrinsic", + "name": "str" }, - "sources": [ + "parameters": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 997 + "id": 1720, + "name": "webhooks", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "list[dict]" + } } - ], - "type": { - "name": "EnvVar", - "type": "reference", - "target": "541" - } + ] } - ], + ] + }, + { + "id": 1721, + "name": "is_retryable_error", + "module": "apify_client._utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Check if the given error is retryable.\n\nAll ``impit.HTTPError`` subclasses are considered retryable because they represent transport-level failures\n(network issues, timeouts, protocol errors, body decoding errors) that are typically transient. HTTP status\ncode errors are handled separately in ``_make_request`` based on the response status code, not here." } ] }, - "decorations": [ + "children": [], + "groups": [], + "sources": [ { - "args": "('Models')", - "name": "docs_group" + "filename": "/src/apify_client/_utils.py", + "line": 283, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_utils.py#L283" } ], - "flags": {}, - "groups": [ + "signatures": [ { - "children": [ - 550, - 549 - ], - "title": "Properties" + "id": 1722, + "name": "is_retryable_error", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if the given error is retryable.\n\nAll ``impit.HTTPError`` subclasses are considered retryable because they represent transport-level failures\n(network issues, timeouts, protocol errors, body decoding errors) that are typically transient. HTTP status\ncode errors are handled separately in ``_make_request`` based on the response status code, not here." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "bool" + }, + "parameters": [ + { + "id": 1723, + "name": "exc", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "Exception" + } + } + ] } - ], - "id": 548, - "module": "_models", - "name": "EnvVarResponse", - "parsedDocstring": { - "text": "" + ] + }, + { + "id": 1724, + "name": "JSONSerializable", + "module": "apify_client._types", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Type for representing json-serializable values. It's close enough to the real thing supported by json.parse.\nIt was suggested in a discussion with (and approved by) Guido van Rossum, so I'd consider it correct enough." + } + ] }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/_types.py", + "line": 5, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 992 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_types.py#L5" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 1725, + "name": "ListPage", + "module": "apify_client._types", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A single page of items returned from a list() method." + } + ] + }, "children": [ { + "id": 1726, + "name": "items", + "module": "apify_client._types", "kind": 1024, "kindString": "Property", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List of returned objects on this page." } ] }, - "flags": {}, - "groups": [], - "id": 552, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "reference", + "name": "list[T]" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/_types.py", + "line": 16, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1002 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_types.py#L16" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 1727, + "name": "count", + "module": "apify_client._types", "kind": 1024, "kindString": "Property", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Count of the returned objects on this page." } ] }, - "flags": {}, - "groups": [], - "id": 553, - "module": "_models", - "name": "type", - "parsedDocstring": { - "text": "" + "type": { + "type": "intrinsic", + "name": "int" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/_types.py", + "line": 19, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1006 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_types.py#L19" } - ], - "type": { - "name": "ErrorType | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ErrorType", - "target": "1796" - }, + ] + }, + { + "id": 1728, + "name": "offset", + "module": "apify_client._types", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "The limit on the number of returned objects offset specified in the API call." } ] - } + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_types.py", + "line": 22, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_types.py#L22" + } + ] }, { + "id": 1729, + "name": "limit", + "module": "apify_client._types", "kind": 1024, "kindString": "Property", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Human-readable error message describing what went wrong." + "text": "The offset of the first object specified in the API call" } ] }, - "flags": {}, - "groups": [], - "id": 554, - "module": "_models", - "name": "message", - "parsedDocstring": { - "text": "Human-readable error message describing what went wrong." + "type": { + "type": "intrinsic", + "name": "int" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/_types.py", + "line": 25, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1007 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_types.py#L25" } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + ] + }, + { + "id": 1730, + "name": "total", + "module": "apify_client._types", + "kind": 1024, + "kindString": "Property", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Total number of objects matching the API call criteria." } ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 554, - 552, - 553 - ], - "title": "Properties" - } - ], - "id": 551, - "module": "_models", - "name": "ErrorDetail", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1001 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "RunFailedErrorDetail", - "target": "989", - "type": "reference" - }, - { - "name": "RunTimeoutExceededErrorDetail", - "target": "1044", - "type": "reference" + }, + "type": { + "type": "intrinsic", + "name": "int" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_client/_types.py", + "line": 28, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_types.py#L28" + } + ] }, { - "name": "UnknownBuildTagErrorDetail", - "target": "1247", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { + "id": 1731, + "name": "desc", + "module": "apify_client._types", "kind": 1024, "kindString": "Property", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Whether the listing is descending or not." } ] }, - "flags": {}, - "groups": [], - "id": 556, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "intrinsic", + "name": "bool" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/_types.py", + "line": 31, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1015 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_types.py#L31" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1732, + "name": "__init__", + "module": "apify_client._types", + "kind": 512, + "kindString": "Constructor", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Initialize a ListPage instance from the API response data." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 557, - "module": "_models", - "name": "error", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/_types.py", + "line": 34, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1019 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_types.py#L34" } ], - "type": { - "name": "ErrorDetail", - "type": "reference", - "target": "551" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + "signatures": [ + { + "id": 1733, + "name": "__init__", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a ListPage instance from the API response data." + } + ] + }, + "type": { + "type": "reference", + "name": "None" + }, + "parameters": [ + { + "id": 1734, + "name": "data", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "dict" + } + } + ] + } + ] } ], - "flags": {}, "groups": [ { + "title": "Constructors", "children": [ - 557, - 556 - ], - "title": "Properties" + 1732 + ] + }, + { + "title": "Properties", + "children": [ + 1727, + 1731, + 1726, + 1729, + 1728, + 1730 + ] } ], - "id": 555, - "module": "_models", - "name": "ErrorResponse", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/_types.py", + "line": 13, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1014 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_types.py#L13" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 1735, + "name": "Statistics", + "module": "apify_client._statistics", "kind": 128, "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statistics about API client usage and rate limit errors." + } + ] + }, "children": [ { + "id": 1736, + "name": "calls", + "module": "apify_client._statistics", "kind": 1024, "kindString": "Property", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Total number of API method calls made by the client." } ] }, - "flags": {}, - "groups": [], - "id": 559, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1024 - } - ], "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] + "type": "intrinsic", + "name": "int" }, - "flags": {}, + "children": [], "groups": [], - "id": 560, - "module": "_models", - "name": "actor_id", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/_statistics.py", + "line": 9, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1028 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_statistics.py#L9" } - ], - "type": { - "name": "str", - "type": "reference" - } + ] }, { + "id": 1737, + "name": "requests", + "module": "apify_client._statistics", "kind": 1024, "kindString": "Property", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Total number of HTTP requests sent, including retries." } ] }, - "flags": {}, - "groups": [], - "id": 561, - "module": "_models", - "name": "actor_run_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1029 - } - ], "type": { - "name": "str", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 560, - 561, - 559 - ], - "title": "Properties" - } - ], - "id": 558, - "module": "_models", - "name": "EventData", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1023 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] + "type": "intrinsic", + "name": "int" }, - "flags": {}, + "children": [], "groups": [], - "id": 563, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/_statistics.py", + "line": 12, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1034 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_statistics.py#L12" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { + "id": 1738, + "name": "rate_limit_errors", + "module": "apify_client._statistics", "kind": 1024, "kindString": "Property", - "children": [], + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "List tracking which retry attempts encountered rate limit (429) errors." } ] }, - "flags": {}, - "groups": [], - "id": 564, - "module": "_models", - "name": "body", - "parsedDocstring": { - "text": "" + "type": { + "type": "reference", + "name": "defaultdict[int, int]" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/_statistics.py", + "line": 15, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1038 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_statistics.py#L15" } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['{ \"helloWorld\": 123 }'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1739, + "name": "add_rate_limit_error", + "module": "apify_client._statistics", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Add rate limit error for specific attempt.\n\nArgs:\n attempt: The attempt number (1-based indexing)." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 565, - "module": "_models", - "name": "content_type", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/_statistics.py", + "line": 18, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1039 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_statistics.py#L18" } ], - "type": { - "name": "Annotated[str | None, Field(alias='contentType', examples=['application/json; charset=utf-8'])]", - "type": "union", - "types": [ - { + "signatures": [ + { + "id": 1740, + "name": "add_rate_limit_error", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add rate limit error for specific attempt.\n\n" + } + ] + }, + "type": { "type": "reference", - "name": "str" + "name": "None" }, - { - "type": "literal", - "value": null - } - ] - } + "parameters": [ + { + "id": 1741, + "name": "attempt", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "int" + } + } + ] + } + ] + } + ], + "groups": [ + { + "title": "Errors", + "children": [ + 1739, + 1738 + ] + }, + { + "title": "Properties", + "children": [ + 1736, + 1737 + ] } ], + "sources": [ + { + "filename": "/src/apify_client/_statistics.py", + "line": 6, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_statistics.py#L6" + } + ] + }, + { + "id": 1742, + "name": "create_redirect_logger", + "module": "apify_client._logging", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Create a logger for redirecting logs from another Actor.\n\nArgs:\n name: The name of the logger. It can be used to inherit from other loggers. Example: `apify.xyz` will use logger\n named `xyz` and make it a children of `apify` logger.\n\nReturns:\n The created logger." } ] }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 564, - 565, - 563 - ], - "title": "Properties" - } - ], - "id": 562, - "module": "_models", - "name": "ExampleRunInput", - "parsedDocstring": { - "text": "" - }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_client/_logging.py", + "line": 129, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1033 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_logging.py#L129" } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, + "id": 1743, + "name": "create_redirect_logger", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", "flags": {}, - "groups": [], - "id": 567, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1044 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Create a logger for redirecting logs from another Actor.\n\n" } ] }, - "flags": {}, - "groups": [], - "id": 568, - "module": "_models", - "name": "status", - "parsedDocstring": { - "text": "" + "type": { + "type": "reference", + "name": "logging.Logger" }, - "sources": [ + "parameters": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1048 + "id": 1744, + "name": "name", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } } - ], - "type": { - "name": "WebhookDispatchStatus", - "type": "reference", - "target": "1803" + ] + } + ] + }, + { + "id": 1745, + "name": "RedirectLogFormatter", + "module": "apify_client._logging", + "kind": 128, + "kindString": "Class", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Formatter applied to default redirect logger." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1746, + "name": "format", + "module": "apify_client._logging", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Format the log by prepending logger name to the original message.\n\nArgs:\n record: Log record to be formatted.\n\nReturns:\n Formatted log message." } ] }, - "flags": {}, + "children": [], "groups": [], - "id": 569, - "module": "_models", - "name": "finished_at", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_client/_logging.py", + "line": 160, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1049 + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_logging.py#L160" } ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-13T08:36:13.202Z'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" + "signatures": [ + { + "id": 1747, + "name": "format", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Format the log by prepending logger name to the original message.\n\n" + } + ] }, - { - "type": "literal", - "value": null - } - ] - } + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 1748, + "name": "record", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "logging.LogRecord" + } + } + ] + } + ] } ], + "groups": [ + { + "title": "Methods", + "children": [ + 1746 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_client/_logging.py", + "line": 157, + "character": 1, + "url": "https://github.com/apify/apify-client-python/blob/master/src/apify_client/_logging.py#L157" + } + ] + }, + { + "id": 1749, + "name": "encode_base62", + "module": "apify_shared.utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Encode the given number to base62." } ] }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 569, - 567, - 568 - ], - "title": "Properties" - } - ], - "id": 566, - "module": "_models", - "name": "ExampleWebhookDispatch", - "parsedDocstring": { - "text": "" - }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/utils.py", + "line": 10, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1043 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/utils.py#L10" } ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + "signatures": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1750, + "name": "encode_base62", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Encode the given number to base62." } ] }, - "flags": {}, - "groups": [], - "id": 571, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "intrinsic", + "name": "str" }, - "sources": [ + "parameters": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1056 + "id": 1751, + "name": "num", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "int" + } } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "CommonActorPricingInfo.model_config", - "target": 370, - "type": "reference" - } - }, + ] + } + ] + }, + { + "id": 1752, + "name": "create_hmac_signature", + "module": "apify_shared.utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate an HMAC signature and encodes it using Base62. Base62 encoding reduces the signature length.\n\nHMAC signature is truncated to 30 characters to make it shorter.\n\nArgs:\n secret_key: Secret key used for signing signatures.\n message: Message to be signed.\n\nReturns:\n Base62 encoded signature." + } + ] + }, + "children": [], + "groups": [], + "sources": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "filename": "/src/apify_shared/utils.py", + "line": 24, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/utils.py#L24" + } + ], + "signatures": [ + { + "id": 1753, + "name": "create_hmac_signature", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Generate an HMAC signature and encodes it using Base62. Base62 encoding reduces the signature length.\n\nHMAC signature is truncated to 30 characters to make it shorter.\n\n" } ] }, - "flags": {}, - "groups": [], - "id": 572, - "module": "_models", - "name": "pricing_model", - "parsedDocstring": { - "text": "" + "type": { + "type": "intrinsic", + "name": "str" }, - "sources": [ + "parameters": [ { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1060 + "id": 1754, + "name": "secret_key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1755, + "name": "message", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } } - ], - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ + ] + } + ] + }, + { + "id": 1756, + "name": "create_storage_content_signature", + "module": "apify_shared.utils", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a secure signature for a resource like a dataset or key-value store.\n\nThis signature is used to generate a signed URL for authenticated access, which can be expiring or permanent.\nThe signature is created using HMAC with the provided secret key and includes the resource ID, expiration time,\nand version.\n\nNote: expires_in_millis is optional. If not provided, the signature will not expire." + } + ] + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/utils.py", + "line": 43, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/utils.py#L43" + } + ], + "signatures": [ + { + "id": 1757, + "name": "create_storage_content_signature", + "modifiers": [], + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": "FLAT_PRICE_PER_MONTH" + "kind": "text", + "text": "Create a secure signature for a resource like a dataset or key-value store.\n\nThis signature is used to generate a signed URL for authenticated access, which can be expiring or permanent.\nThe signature is created using HMAC with the provided secret key and includes the resource ID, expiration time,\nand version.\n\nNote: expires_in_millis is optional. If not provided, the signature will not expire." } ] + }, + "type": { + "type": "intrinsic", + "name": "str" + }, + "parameters": [ + { + "id": 1758, + "name": "resource_id", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1759, + "name": "url_signing_secret_key", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "str" + } + }, + { + "id": 1760, + "name": "expires_in_millis", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "int | None" + }, + "defaultValue": "None" + }, + { + "id": 1761, + "name": "version", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "int" + }, + "defaultValue": "0" + } + ] + } + ] + }, + { + "id": 1762, + "name": "ActorJobStatus", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Available statuses for Actor jobs (runs or builds).\n\nThese statuses represent the lifecycle of an Actor execution,\nfrom initialization to completion or termination." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1763, + "name": "READY", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "For how long this Actor can be used for free in trial period" + "text": "Actor job has been initialized but not yet started." } ] }, - "flags": {}, - "groups": [], - "id": 573, - "module": "_models", - "name": "trial_minutes", - "parsedDocstring": { - "text": "For how long this Actor can be used for free in trial period" + "type": { + "type": "literal", + "value": "'READY'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 14, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1061 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L14" } - ], - "type": { - "name": "int", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1764, + "name": "RUNNING", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Monthly flat price in USD" + "text": "Actor job is currently executing." } ] }, - "flags": {}, - "groups": [], - "id": 574, - "module": "_models", - "name": "price_per_unit_usd", - "parsedDocstring": { - "text": "Monthly flat price in USD" + "type": { + "type": "literal", + "value": "'RUNNING'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 17, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1065 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L17" } - ], - "type": { - "name": "float", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1765, + "name": "SUCCEEDED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" + "text": "Actor job completed successfully without errors." } ] }, - "flags": {}, - "groups": [], - "id": 4116, - "module": "_models", - "name": "apify_margin_percentage", - "parsedDocstring": { - "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" + "type": { + "type": "literal", + "value": "'SUCCEEDED'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 20, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 518 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L20" } - ], - "type": { - "name": "Annotated[float, Field(alias='apifyMarginPercentage')]", - "type": "reference" - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.apify_margin_percentage", - "target": 371, - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1766, + "name": "FAILED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "When this pricing info record has been created" + "text": "Actor job or build failed due to an error or exception." } ] }, - "flags": {}, - "groups": [], - "id": 4117, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "When this pricing info record has been created" + "type": { + "type": "literal", + "value": "'FAILED'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 23, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 522 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L23" } - ], - "type": { - "name": "Annotated[AwareDatetime, Field(alias='createdAt')]", - "type": "reference" - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.created_at", - "target": 372, - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1767, + "name": "TIMING_OUT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Since when is this pricing info record effective for a given Actor" + "text": "Actor job is currently in the process of timing out." } ] }, - "flags": {}, - "groups": [], - "id": 4118, - "module": "_models", - "name": "started_at", - "parsedDocstring": { - "text": "Since when is this pricing info record effective for a given Actor" + "type": { + "type": "literal", + "value": "'TIMING-OUT'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 26, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 526 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L26" } - ], - "type": { - "name": "Annotated[AwareDatetime, Field(alias='startedAt')]", - "type": "reference" - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.started_at", - "target": 373, - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1768, + "name": "TIMED_OUT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Actor job was terminated due to timeout." } ] }, - "flags": {}, - "groups": [], - "id": 4119, - "module": "_models", - "name": "notified_about_future_change_at", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'TIMED-OUT'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 29, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 530 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L29" } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutFutureChangeAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.notified_about_future_change_at", - "target": 374, - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1769, + "name": "ABORTING", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Actor job is currently being aborted by user request." } ] }, - "flags": {}, - "groups": [], - "id": 4120, - "module": "_models", - "name": "notified_about_change_at", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ABORTING'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 32, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 531 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L32" } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutChangeAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.notified_about_change_at", - "target": 375, - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1770, + "name": "ABORTED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Actor job was successfully aborted by user request." } ] }, - "flags": {}, - "groups": [], - "id": 4121, - "module": "_models", - "name": "reason_for_change", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ABORTED'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 35, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 532 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L35" } - ], - "type": { - "name": "Annotated[str | None, Field(alias='reasonForChange')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + ] + }, + { + "id": 1771, + "name": "is_terminal", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Whether this Actor job status is terminal." } ] }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.reason_for_change", - "target": 376, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + "type": { + "type": "literal" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 39, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L39" + } + ] } ], - "flags": {}, "groups": [ { + "title": "Enumeration Members", "children": [ - 4116, - 4117, - 571, - 4120, - 4119, - 574, - 572, - 4121, - 4118, - 573 - ], - "title": "Properties" + 1770, + 1769, + 1766, + 1771, + 1763, + 1764, + 1765, + 1768, + 1767 + ] } ], - "id": 570, - "module": "_models", - "name": "FlatPricePerMonthActorPricingInfo", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 7, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1055 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "CommonActorPricingInfo", - "target": "369", - "type": "reference" + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L7" } ] }, { - "kind": 128, - "kindString": "Class", + "id": 1772, + "name": "ActorSourceType", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Available source code types for Actors.\n\nDefines how Actor source code is stored and accessed\nfor building and executing Actors on the platform." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1773, + "name": "SOURCE_FILES", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Actor source code consists of multiple individual files uploaded directly." } ] }, - "flags": {}, - "groups": [], - "id": 576, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'SOURCE_FILES'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 56, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1073 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L56" } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "CommonActorPricingInfo.model_config", - "target": 370, - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1774, + "name": "GIT_REPO", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Actor source code is cloned from a Git repository (GitHub, GitLab, etc.)." } ] }, - "flags": {}, - "groups": [], - "id": 577, - "module": "_models", - "name": "pricing_model", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'GIT_REPO'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 59, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1077 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L59" } - ], - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "FREE" - } - ] - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1775, + "name": "TARBALL", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" + "text": "Actor source code is downloaded from a tarball or ZIP archive." } ] }, - "flags": {}, - "groups": [], - "id": 4122, - "module": "_models", - "name": "apify_margin_percentage", - "parsedDocstring": { - "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" + "type": { + "type": "literal", + "value": "'TARBALL'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 62, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 518 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L62" } - ], - "type": { - "name": "Annotated[float, Field(alias='apifyMarginPercentage')]", - "type": "reference" - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.apify_margin_percentage", - "target": 371, - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1776, + "name": "GITHUB_GIST", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "When this pricing info record has been created" + "text": "Actor source code is retrieved from a GitHub Gist." } ] }, - "flags": {}, - "groups": [], - "id": 4123, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "When this pricing info record has been created" + "type": { + "type": "literal", + "value": "'GITHUB_GIST'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 65, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 522 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L65" } - ], - "type": { - "name": "Annotated[AwareDatetime, Field(alias='createdAt')]", - "type": "reference" - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.created_at", - "target": 372, - "type": "reference" + ] + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 1774, + 1776, + 1773, + 1775 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 49, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L49" + } + ] + }, + { + "id": 1777, + "name": "ActorEventTypes", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Event types that can be sent to Actors during execution.\n\nThese events provide real-time information about system state\nand lifecycle changes that Actors can respond to." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1778, + "name": "SYSTEM_INFO", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Since when is this pricing info record effective for a given Actor" + "text": "Information about resource usage and system metrics of the Actor." } ] }, - "flags": {}, - "groups": [], - "id": 4124, - "module": "_models", - "name": "started_at", - "parsedDocstring": { - "text": "Since when is this pricing info record effective for a given Actor" + "type": { + "type": "literal", + "value": "'systemInfo'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 76, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 526 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L76" } - ], - "type": { - "name": "Annotated[AwareDatetime, Field(alias='startedAt')]", - "type": "reference" - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.started_at", - "target": 373, - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1779, + "name": "MIGRATING", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Notification that the Actor is about to be migrated to another server." } ] }, - "flags": {}, - "groups": [], - "id": 4125, - "module": "_models", - "name": "notified_about_future_change_at", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'migrating'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 79, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 530 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L79" } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutFutureChangeAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.notified_about_future_change_at", - "target": 374, - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1780, + "name": "PERSIST_STATE", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Signal to persist Actor state - sent every minute or before migration." } ] }, - "flags": {}, - "groups": [], - "id": 4126, - "module": "_models", - "name": "notified_about_change_at", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'persistState'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 82, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 531 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L82" } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutChangeAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.notified_about_change_at", - "target": 375, - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1781, + "name": "ABORTING", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Notification that the Actor is being terminated and should clean up." } ] }, - "flags": {}, - "groups": [], - "id": 4127, - "module": "_models", - "name": "reason_for_change", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'aborting'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 85, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 532 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L85" } - ], - "type": { - "name": "Annotated[str | None, Field(alias='reasonForChange')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.reason_for_change", - "target": 376, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + ] } ], - "flags": {}, "groups": [ { + "title": "Enumeration Members", "children": [ - 4122, - 4123, - 576, - 4126, - 4125, - 577, - 4127, - 4124 - ], - "title": "Properties" + 1781, + 1779, + 1780, + 1778 + ] } ], - "id": 575, - "module": "_models", - "name": "FreeActorPricingInfo", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 69, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1072 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "CommonActorPricingInfo", - "target": "369", - "type": "reference" + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L69" } ] }, { - "kind": 128, - "kindString": "Class", + "id": 1782, + "name": "ActorEnvVars", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Environment variables with ACTOR_ prefix set by the Apify platform.\n\nThese variables provide essential context about the current Actor run,\nincluding identifiers, resource limits, and configuration details.\nAll variables are automatically set by the platform during Actor execution." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1783, + "name": "BUILD_ID", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Unique identifier of the Actor build used for this run." } ] }, - "flags": {}, - "groups": [], - "id": 579, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR_BUILD_ID'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 97, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1084 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L97" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1784, + "name": "BUILD_NUMBER", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Sequential build number of the Actor build used for this run." } ] }, - "flags": {}, - "groups": [], - "id": 580, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR_BUILD_NUMBER'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 100, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1088 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L100" } - ], - "type": { - "name": "LockedRequestQueueHead", - "type": "reference", - "target": "721" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response containing locked requests from the request queue head." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 580, - 579 - ], - "title": "Properties" - } - ], - "id": 578, - "module": "_models", - "name": "HeadAndLockResponse", - "parsedDocstring": { - "text": "Response containing locked requests from the request queue head." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1081 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1785, + "name": "BUILD_TAGS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Comma-separated list of tags associated with the Actor build." } ] }, - "flags": {}, - "groups": [], - "id": 582, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR_BUILD_TAGS'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 103, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1095 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L103" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1786, + "name": "DEFAULT_DATASET_ID", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique identifier assigned to the request." + "text": "Unique identifier of the default dataset for storing Actor results." } ] }, - "flags": {}, - "groups": [], - "id": 583, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request." + "type": { + "type": "literal", + "value": "'ACTOR_DEFAULT_DATASET_ID'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 106, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1099 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L106" } - ], - "type": { - "name": "str", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1787, + "name": "DEFAULT_KEY_VALUE_STORE_ID", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + "text": "Unique identifier of the default key-value store for Actor data." } ] }, - "flags": {}, - "groups": [], - "id": 584, - "module": "_models", - "name": "unique_key", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + "type": { + "type": "literal", + "value": "'ACTOR_DEFAULT_KEY_VALUE_STORE_ID'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 109, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1103 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L109" } - ], - "type": { - "name": "str", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1788, + "name": "DEFAULT_REQUEST_QUEUE_ID", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The URL of the request." + "text": "Unique identifier of the default request queue for Actor URLs." } ] }, - "flags": {}, - "groups": [], - "id": 585, - "module": "_models", - "name": "url", - "parsedDocstring": { - "text": "The URL of the request." + "type": { + "type": "literal", + "value": "'ACTOR_DEFAULT_REQUEST_QUEUE_ID'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 112, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1107 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L112" } - ], - "type": { - "name": "str", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1789, + "name": "EVENTS_WEBSOCKET_URL", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "WebSocket URL for receiving real-time events from the platform." } ] }, - "flags": {}, - "groups": [], - "id": 586, - "module": "_models", - "name": "method", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR_EVENTS_WEBSOCKET_URL'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 115, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1111 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L115" } - ], - "type": { - "name": "HttpMethod | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "HttpMethod", - "target": "1798" - }, - { - "type": "literal", - "value": null - } - ] - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1790, + "name": "FULL_NAME", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The number of times this request has been retried." + "text": "Full Actor name in format 'username/actor-name' for identification." } ] }, - "flags": {}, - "groups": [], - "id": 587, - "module": "_models", - "name": "retry_count", - "parsedDocstring": { - "text": "The number of times this request has been retried." + "type": { + "type": "literal", + "value": "'ACTOR_FULL_NAME'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 118, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1112 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L118" } - ], - "type": { - "name": "Annotated[int | None, Field(alias='retryCount', examples=[0])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A request from the request queue head without lock information." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 583, - 586, - 582, - 587, - 584, - 585 - ], - "title": "Properties" - } - ], - "id": 581, - "module": "_models", - "name": "HeadRequest", - "parsedDocstring": { - "text": "A request from the request queue head without lock information." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1092 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1791, + "name": "ID", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Unique identifier of the Actor definition." } ] }, - "flags": {}, - "groups": [], - "id": 589, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR_ID'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 121, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1122 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L121" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1792, + "name": "INPUT_KEY", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Key in the default key-value store where Actor input is stored (usually 'INPUT')." } ] }, - "flags": {}, - "groups": [], - "id": 590, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR_INPUT_KEY'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 124, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1126 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L124" } - ], - "type": { - "name": "RequestQueueHead", - "type": "reference", - "target": "913" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response containing requests from the request queue head without locking." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 590, - 589 - ], - "title": "Properties" - } - ], - "id": 588, - "module": "_models", - "name": "HeadResponse", - "parsedDocstring": { - "text": "Response containing requests from the request queue head without locking." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1119 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1793, + "name": "MAX_PAID_DATASET_ITEMS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Maximum number of dataset items that will be charged for pay-per-result Actors." } ] }, - "flags": {}, - "groups": [], - "id": 592, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR_MAX_PAID_DATASET_ITEMS'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 127, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1131 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L127" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1794, + "name": "MAX_TOTAL_CHARGE_USD", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The position of the invalid item in the array." + "text": "Maximum total charge limit in USD for pay-per-event Actors." } ] }, - "flags": {}, - "groups": [], - "id": 593, - "module": "_models", - "name": "item_position", - "parsedDocstring": { - "text": "The position of the invalid item in the array." + "type": { + "type": "literal", + "value": "'ACTOR_MAX_TOTAL_CHARGE_USD'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 130, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1135 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L130" } - ], - "type": { - "name": "Annotated[int | None, Field(alias='itemPosition', examples=[2])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1795, + "name": "MEMORY_MBYTES", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A complete list of AJV validation error objects for the invalid item." + "text": "Amount of memory allocated to the Actor run in megabytes." } ] }, - "flags": {}, - "groups": [], - "id": 594, - "module": "_models", - "name": "validation_errors", - "parsedDocstring": { - "text": "A complete list of AJV validation error objects for the invalid item." + "type": { + "type": "literal", + "value": "'ACTOR_MEMORY_MBYTES'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 133, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1139 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L133" } - ], - "type": { - "name": "Annotated[list[ValidationError] | None, Field(alias='validationErrors')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "ValidationError", - "target": "1329" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 593, - 592, - 594 - ], - "title": "Properties" - } - ], - "id": 591, - "module": "_models", - "name": "InvalidItem", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1130 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1796, + "name": "PERMISSION_LEVEL", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Permission level of the Actor." } ] }, - "flags": {}, - "groups": [], - "id": 596, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR_PERMISSION_LEVEL'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 136, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1147 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L136" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1797, + "name": "RUN_ID", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Unique identifier of this specific Actor run execution." } ] }, - "flags": {}, - "groups": [], - "id": 597, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR_RUN_ID'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 139, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1151 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L139" } - ], - "type": { - "name": "str", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1798, + "name": "STANDBY_PORT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "TCP port number for Actor standby mode HTTP server." } ] }, - "flags": {}, - "groups": [], - "id": 598, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR_STANDBY_PORT'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 142, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1152 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L142" } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['d7b9MDYsbtX5L7XAj'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1799, + "name": "STANDBY_URL", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Public URL for accessing the Actor in standby mode." } ] }, - "flags": {}, - "groups": [], - "id": 599, - "module": "_models", - "name": "user_id", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR_STANDBY_URL'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 145, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1153 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L145" } - ], - "type": { - "name": "Annotated[str | None, Field(alias='userId', examples=['BPWDBd7Z9c746JAnF'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1800, + "name": "STARTED_AT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "ISO 8601 timestamp when the Actor run was started (UTC timezone)." } ] }, - "flags": {}, - "groups": [], - "id": 600, - "module": "_models", - "name": "username", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR_STARTED_AT'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 148, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1154 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L148" } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['janedoe'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1801, + "name": "TASK_ID", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Unique identifier of the Actor task (empty if run directly via API)." } ] }, - "flags": {}, - "groups": [], - "id": 601, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR_TASK_ID'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 151, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1155 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L151" } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1802, + "name": "TIMEOUT_AT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "ISO 8601 timestamp when the Actor run will timeout (UTC timezone)." } ] }, - "flags": {}, - "groups": [], - "id": 602, - "module": "_models", - "name": "modified_at", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR_TIMEOUT_AT'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 154, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1156 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L154" } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1803, + "name": "WEB_SERVER_PORT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "TCP port number for the Actor's built-in HTTP web server." } ] }, - "flags": {}, - "groups": [], - "id": 603, - "module": "_models", - "name": "accessed_at", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR_WEB_SERVER_PORT'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 157, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1157 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L157" } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1804, + "name": "WEB_SERVER_URL", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Public URL for accessing the Actor's built-in HTTP web server." } ] }, - "flags": {}, - "groups": [], - "id": 604, - "module": "_models", - "name": "act_id", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR_WEB_SERVER_URL'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 160, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1158 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L160" } - ], - "type": { - "name": "Annotated[str | None, Field(alias='actId', examples=[None])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] + ] + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 1783, + 1784, + 1785, + 1786, + 1787, + 1788, + 1789, + 1790, + 1791, + 1792, + 1793, + 1794, + 1795, + 1796, + 1797, + 1798, + 1799, + 1800, + 1801, + 1802, + 1803, + 1804 + ] + } + ], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 89, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L89" + } + ] + }, + { + "id": 1805, + "name": "ApifyEnvVars", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Environment variables with APIFY_ prefix set by the Apify platform.\n\nThese variables provide configuration, authentication, and platform-specific\nsettings for Actors running on the Apify platform. They control behavior\nlike logging, proxy settings, browser configuration, and platform integration." } - }, + ] + }, + "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1806, + "name": "API_BASE_URL", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Base URL of the Apify API (typically 'https://api.apify.com')." } ] }, - "flags": {}, - "groups": [], - "id": 605, - "module": "_models", - "name": "act_run_id", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_API_BASE_URL'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 172, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1159 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L172" } - ], - "type": { - "name": "Annotated[str | None, Field(alias='actRunId', examples=[None])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1807, + "name": "API_PUBLIC_BASE_URL", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Public URL of the Apify API accessible from external networks." } ] }, - "flags": {}, - "groups": [], - "id": 606, - "module": "_models", - "name": "console_url", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_API_PUBLIC_BASE_URL'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 175, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1160 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L175" } - ], - "type": { - "name": "Annotated[ AnyUrl | None, Field(alias='consoleUrl', examples=['https://console.apify.com/storage/key-value-stores/27TmTznX9YPeAYhkC']), ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AnyUrl" - }, - { - "type": "literal", - "value": null - } - ] - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1808, + "name": "DEDICATED_CPUS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A public link to access keys of the key-value store directly." + "text": "Number of dedicated CPU cores allocated to the Actor based on memory allocation." } ] }, - "flags": {}, - "groups": [], - "id": 607, - "module": "_models", - "name": "keys_public_url", - "parsedDocstring": { - "text": "A public link to access keys of the key-value store directly." + "type": { + "type": "literal", + "value": "'APIFY_DEDICATED_CPUS'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 178, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1164 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L178" } - ], - "type": { - "name": "Annotated[ AnyUrl | None, Field( alias='keysPublicUrl', examples=['https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/keys?signature=abc123'], ), ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AnyUrl" - }, - { - "type": "literal", - "value": null - } - ] - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1809, + "name": "DEFAULT_BROWSER_PATH", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the key-value store." + "text": "File system path to the default browser executable for web scraping." } ] }, - "flags": {}, - "groups": [], - "id": 608, - "module": "_models", - "name": "url_signing_secret_key", - "parsedDocstring": { - "text": "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the key-value store." + "type": { + "type": "literal", + "value": "'APIFY_DEFAULT_BROWSER_PATH'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 181, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1174 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L181" } - ], - "type": { - "name": "Annotated[str | None, Field(alias='urlSigningSecretKey')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1810, + "name": "DISABLE_BROWSER_SANDBOX", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Set to '1' to disable browser sandbox mode for compatibility with containerized environments." } ] }, - "flags": {}, - "groups": [], - "id": 609, - "module": "_models", - "name": "general_access", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_DISABLE_BROWSER_SANDBOX'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 184, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1178 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L184" } - ], - "type": { - "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "GeneralAccess", - "target": "1797" - }, - { - "type": "literal", - "value": null - } - ] - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1811, + "name": "DISABLE_OUTDATED_WARNING", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Set to '1' to suppress warnings about outdated SDK versions." } ] }, - "flags": {}, - "groups": [], - "id": 610, - "module": "_models", - "name": "stats", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_DISABLE_OUTDATED_WARNING'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 187, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1179 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L187" } - ], - "type": { - "name": "KeyValueStoreStats | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "KeyValueStoreStats", - "target": "619" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 603, - 604, - 605, - 606, - 601, - 609, - 597, - 607, - 596, - 602, - 598, - 610, - 608, - 599, - 600 - ], - "title": "Properties" - } - ], - "id": 595, - "module": "_models", - "name": "KeyValueStore", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1146 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1812, + "name": "FACT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Fun fact about the Apify platform displayed during Actor startup." } ] }, - "flags": {}, - "groups": [], - "id": 612, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_FACT'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 190, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1184 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L190" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1813, + "name": "HEADLESS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Set to '1' to run browsers in headless mode without graphical interface." } ] }, - "flags": {}, - "groups": [], - "id": 613, - "module": "_models", - "name": "key", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_HEADLESS'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 193, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1188 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L193" } - ], - "type": { - "name": "str", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1814, + "name": "INPUT_SECRETS_PRIVATE_KEY_FILE", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Path to the private key file used for decrypting secret input values." } ] }, - "flags": {}, - "groups": [], - "id": 614, - "module": "_models", - "name": "size", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_INPUT_SECRETS_PRIVATE_KEY_FILE'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 196, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1189 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L196" } - ], - "type": { - "name": "int", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1815, + "name": "INPUT_SECRETS_PRIVATE_KEY_PASSPHRASE", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A public link to access this record directly." + "text": "Passphrase for unlocking the private key file used for secret decryption." } ] }, - "flags": {}, - "groups": [], - "id": 615, - "module": "_models", - "name": "record_public_url", - "parsedDocstring": { - "text": "A public link to access this record directly." + "type": { + "type": "literal", + "value": "'APIFY_INPUT_SECRETS_PRIVATE_KEY_PASSPHRASE'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 199, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1190 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L199" } - ], - "type": { - "name": "AnyUrl", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 613, - 612, - 615, - 614 - ], - "title": "Properties" - } - ], - "id": 611, - "module": "_models", - "name": "KeyValueStoreKey", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1183 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1816, + "name": "IS_AT_HOME", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Set to '1' when the Actor is running on official Apify platform infrastructure." } ] }, - "flags": {}, - "groups": [], - "id": 617, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_IS_AT_HOME'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 202, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1206 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L202" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1817, + "name": "LOCAL_STORAGE_DIR", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Local file system directory path where Actor data and storage is persisted." } ] }, - "flags": {}, - "groups": [], - "id": 618, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_LOCAL_STORAGE_DIR'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 205, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1210 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L205" } - ], - "type": { - "name": "KeyValueStore", - "type": "reference", - "target": "595" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response containing key-value store data." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 618, - 617 - ], - "title": "Properties" - } - ], - "id": 616, - "module": "_models", - "name": "KeyValueStoreResponse", - "parsedDocstring": { - "text": "Response containing key-value store data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1203 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1818, + "name": "LOG_FORMAT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Logging output format: 'pretty' for human-readable, 'json' for structured logs." } ] }, - "flags": {}, - "groups": [], - "id": 620, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_LOG_FORMAT'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 208, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1215 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L208" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1819, + "name": "LOG_LEVEL", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Minimum logging level: 'DEBUG', 'INFO', 'WARNING', 'ERROR' in ascending order." } ] }, - "flags": {}, - "groups": [], - "id": 621, - "module": "_models", - "name": "read_count", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_LOG_LEVEL'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 211, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1219 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L211" } - ], - "type": { - "name": "int", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1820, + "name": "MAX_USED_CPU_RATIO", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Maximum CPU utilization ratio (0.0-1.0) that the Actor should not exceed." } ] }, - "flags": {}, - "groups": [], - "id": 622, - "module": "_models", - "name": "write_count", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_MAX_USED_CPU_RATIO'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 214, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1220 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L214" } - ], - "type": { - "name": "int", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1821, + "name": "META_ORIGIN", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "How the Actor run was initiated: 'WEB', 'API', 'SCHEDULER', 'TEST', etc." } ] }, - "flags": {}, - "groups": [], - "id": 623, - "module": "_models", - "name": "delete_count", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_META_ORIGIN'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 217, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1221 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L217" } - ], - "type": { - "name": "int", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1822, + "name": "METAMORPH_AFTER_SLEEP_MILLIS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Milliseconds to wait before Actor metamorphosis (transformation) occurs." } ] }, - "flags": {}, - "groups": [], - "id": 624, - "module": "_models", - "name": "list_count", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_METAMORPH_AFTER_SLEEP_MILLIS'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 220, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1222 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L220" } - ], - "type": { - "name": "int", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1823, + "name": "PERSIST_STATE_INTERVAL_MILLIS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Interval in milliseconds for automatic state persistence (default: 60000ms)." } ] }, - "flags": {}, - "groups": [], - "id": 625, - "module": "_models", - "name": "s3_storage_bytes", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_PERSIST_STATE_INTERVAL_MILLIS'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 223, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1223 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L223" } - ], - "type": { - "name": "Annotated[int | None, Field(alias='s3StorageBytes', examples=[18])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 623, - 624, - 620, - 621, - 625, - 622 - ], - "title": "Properties" - } - ], - "id": 619, - "module": "_models", - "name": "KeyValueStoreStats", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1214 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1824, + "name": "PERSIST_STORAGE", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Set to '1' to persist Actor storage data after run completion." } ] }, - "flags": {}, - "groups": [], - "id": 627, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_PERSIST_STORAGE'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 226, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1230 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L226" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1825, + "name": "PROXY_HOSTNAME", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "ID of the default key-value store for this run." + "text": "Hostname for Apify Proxy service (typically 'proxy.apify.com')." } ] }, - "flags": {}, - "groups": [], - "id": 628, - "module": "_models", - "name": "default", - "parsedDocstring": { - "text": "ID of the default key-value store for this run." + "type": { + "type": "literal", + "value": "'APIFY_PROXY_HOSTNAME'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 229, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1234 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L229" } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['eJNzqsbPiopwJcgGQ'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, + ] + }, + { + "id": 1826, + "name": "PROXY_PASSWORD", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ { - "type": "literal", - "value": null + "kind": "text", + "text": "Authentication password for accessing Apify Proxy services." } ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Aliased key-value store IDs for this run." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 628, - 627 - ], - "title": "Properties" - } - ], - "id": 626, - "module": "_models", - "name": "KeyValueStores", - "parsedDocstring": { - "text": "Aliased key-value store IDs for this run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1227 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 630, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1242 - } - ], "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] + "type": "literal", + "value": "'APIFY_PROXY_PASSWORD'" }, - "flags": {}, + "children": [], "groups": [], - "id": 631, - "module": "_models", - "name": "max_monthly_usage_usd", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 232, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1246 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L232" } - ], - "type": { - "name": "float", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1827, + "name": "PROXY_PORT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "TCP port number for connecting to Apify Proxy (typically 8000)." } ] }, - "flags": {}, - "groups": [], - "id": 632, - "module": "_models", - "name": "max_monthly_actor_compute_units", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1247 - } - ], "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] + "type": "literal", + "value": "'APIFY_PROXY_PORT'" }, - "flags": {}, + "children": [], "groups": [], - "id": 633, - "module": "_models", - "name": "max_monthly_external_data_transfer_gbytes", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 235, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1248 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L235" } - ], - "type": { - "name": "float", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1828, + "name": "PROXY_STATUS_URL", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "URL endpoint for retrieving Apify Proxy status and connection information." } ] }, - "flags": {}, - "groups": [], - "id": 634, - "module": "_models", - "name": "max_monthly_proxy_serps", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_PROXY_STATUS_URL'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 238, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1251 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L238" } - ], - "type": { - "name": "int", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1829, + "name": "PURGE_ON_START", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Set to '1' to clear all local storage before Actor execution begins." } ] }, - "flags": {}, - "groups": [], - "id": 635, - "module": "_models", - "name": "max_monthly_residential_proxy_gbytes", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_PURGE_ON_START'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 241, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1252 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L241" } - ], - "type": { - "name": "float", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1830, + "name": "SDK_LATEST_VERSION", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Latest available version of the Apify SDK for update notifications." } ] }, - "flags": {}, - "groups": [], - "id": 636, - "module": "_models", - "name": "max_actor_memory_gbytes", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_SDK_LATEST_VERSION'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 244, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1255 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L244" } - ], - "type": { - "name": "float", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1831, + "name": "SYSTEM_INFO_INTERVAL_MILLIS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Interval in milliseconds for sending system resource usage information." } ] }, - "flags": {}, - "groups": [], - "id": 637, - "module": "_models", - "name": "max_actor_count", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_SYSTEM_INFO_INTERVAL_MILLIS'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 247, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1256 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L247" } - ], - "type": { - "name": "int", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1832, + "name": "TOKEN", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "API authentication token of the user who initiated the Actor run." } ] }, - "flags": {}, - "groups": [], - "id": 638, - "module": "_models", - "name": "max_actor_task_count", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_TOKEN'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 250, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1257 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L250" } - ], - "type": { - "name": "int", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1833, + "name": "USER_ID", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Unique identifier of the user who started the Actor (may differ from Actor owner)." } ] }, - "flags": {}, - "groups": [], - "id": 639, - "module": "_models", - "name": "max_concurrent_actor_jobs", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_USER_ID'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 253, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1258 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L253" } - ], - "type": { - "name": "int", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1834, + "name": "USER_IS_PAYING", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Set to '1' if the user who started the Actor has an active paid subscription." } ] }, - "flags": {}, - "groups": [], - "id": 640, - "module": "_models", - "name": "max_team_account_seat_count", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_USER_IS_PAYING'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 256, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1259 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L256" } - ], - "type": { - "name": "int", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1835, + "name": "WORKFLOW_KEY", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Unique identifier for grouping related Actor runs and API operations together." } ] }, - "flags": {}, - "groups": [], - "id": 641, - "module": "_models", - "name": "data_retention_days", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'APIFY_WORKFLOW_KEY'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 259, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1260 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L259" } - ], - "type": { - "name": "int", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + ] } ], - "flags": {}, "groups": [ { + "title": "Enumeration Members", "children": [ - 641, - 637, - 636, - 638, - 639, - 632, - 633, - 634, - 635, - 631, - 640, - 630 - ], - "title": "Properties" + 1806, + 1807, + 1808, + 1809, + 1810, + 1811, + 1812, + 1813, + 1814, + 1815, + 1816, + 1817, + 1818, + 1819, + 1820, + 1821, + 1822, + 1823, + 1824, + 1825, + 1826, + 1827, + 1828, + 1829, + 1830, + 1831, + 1832, + 1833, + 1834, + 1835 + ] } ], - "id": 629, - "module": "_models", - "name": "Limits", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 164, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1241 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L164" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 128, - "kindString": "Class", + "id": 1836, + "name": "ActorExitCodes", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Standard exit codes used by Actors to indicate run completion status.\n\nThese codes follow Unix conventions where 0 indicates success\nand non-zero values indicate various types of failures." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1837, + "name": "SUCCESS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Actor completed successfully without any errors." } ] }, - "flags": {}, - "groups": [], - "id": 643, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "0" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 270, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1265 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L270" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1838, + "name": "ERROR_USER_FUNCTION_THREW", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Actor failed because the main function threw an unhandled exception." } ] }, - "flags": {}, - "groups": [], - "id": 644, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "91" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 273, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1269 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L273" } - ], - "type": { - "name": "AccountLimits", - "type": "reference", - "target": "187" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" + ] } ], - "flags": {}, "groups": [ { + "title": "Errors", "children": [ - 644, - 643 - ], - "title": "Properties" + 1838 + ] + }, + { + "title": "Enumeration Members", + "children": [ + 1837 + ] } ], - "id": 642, - "module": "_models", - "name": "LimitsResponse", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 263, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1264 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L263" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 128, - "kindString": "Class", + "id": 1839, + "name": "WebhookEventType", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Event types that can trigger webhook notifications.\n\nThese events are sent to configured webhook URLs when specific\nActor run or build lifecycle events occur, enabling integration\nwith external systems and automated workflows." + } + ] + }, "children": [ { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1840, + "name": "ACTOR_RUN_CREATED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Triggered when a new Actor run is created and initialized." } ] }, - "flags": {}, - "groups": [], - "id": 646, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR.RUN.CREATED'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 285, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1274 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L285" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1841, + "name": "ACTOR_RUN_SUCCEEDED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Triggered when an Actor run completes successfully." } ] }, - "flags": {}, - "groups": [], - "id": 647, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR.RUN.SUCCEEDED'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 288, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1278 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L288" } - ], - "type": { - "name": "ListOfStoreActors", - "type": "reference", - "target": "774" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 647, - 646 - ], - "title": "Properties" - } - ], - "id": 645, - "module": "_models", - "name": "ListOfActorsInStoreResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1273 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1842, + "name": "ACTOR_RUN_FAILED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Triggered when an Actor run fails due to an error." } ] }, - "flags": {}, - "groups": [], - "id": 649, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR.RUN.FAILED'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 291, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1283 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L291" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1843, + "name": "ACTOR_RUN_TIMED_OUT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Triggered when an Actor run is terminated due to timeout." } ] }, - "flags": {}, - "groups": [], - "id": 650, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR.RUN.TIMED_OUT'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 294, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1287 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L294" } - ], - "type": { - "name": "ListOfActors", - "type": "reference", - "target": "753" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 650, - 649 - ], - "title": "Properties" - } - ], - "id": 648, - "module": "_models", - "name": "ListOfActorsResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1282 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1844, + "name": "ACTOR_RUN_ABORTED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Triggered when an Actor run is manually aborted by user." } ] }, - "flags": {}, - "groups": [], - "id": 652, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR.RUN.ABORTED'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 297, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1292 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L297" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1845, + "name": "ACTOR_RUN_RESURRECTED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Triggered when a previously failed Actor run is automatically resurrected." } ] }, - "flags": {}, - "groups": [], - "id": 653, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR.RUN.RESURRECTED'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 300, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1296 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L300" } - ], - "type": { - "name": "ListOfBuilds", - "type": "reference", - "target": "756" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 653, - 652 - ], - "title": "Properties" - } - ], - "id": 651, - "module": "_models", - "name": "ListOfBuildsResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1291 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ + ] + }, { - "kind": 1024, - "kindString": "Property", - "children": [], + "id": 1846, + "name": "ACTOR_BUILD_CREATED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Triggered when a new Actor build process is initiated." } ] }, - "flags": {}, - "groups": [], - "id": 655, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" + "type": { + "type": "literal", + "value": "'ACTOR.BUILD.CREATED'" }, + "children": [], + "groups": [], "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 303, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1301 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L303" } - ], - "type": { - "name": "Undefined", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 656, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1305 - } - ], - "type": { - "name": "ListOfDatasets", - "type": "reference", - "target": "759" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 656, - 655 - ], - "title": "Properties" - } - ], - "id": 654, - "module": "_models", - "name": "ListOfDatasetsResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1300 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 658, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1310 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 659, - "module": "_models", - "name": "total", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1314 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 660, - "module": "_models", - "name": "items", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1315 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "EnvVar", - "target": "541" - } - ], - "target": "2199" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 660, - 658, - 659 - ], - "title": "Properties" - } - ], - "id": 657, - "module": "_models", - "name": "ListOfEnvVars", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1309 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 662, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1320 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 663, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1324 - } - ], - "type": { - "name": "ListOfEnvVars", - "type": "reference", - "target": "657" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 663, - 662 - ], - "title": "Properties" - } - ], - "id": 661, - "module": "_models", - "name": "ListOfEnvVarsResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1319 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 665, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1329 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 666, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1333 - } - ], - "type": { - "name": "ListOfKeyValueStores", - "type": "reference", - "target": "762" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 666, - 665 - ], - "title": "Properties" - } - ], - "id": 664, - "module": "_models", - "name": "ListOfKeyValueStoresResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1328 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 668, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1338 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 669, - "module": "_models", - "name": "items", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1342 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "KeyValueStoreKey", - "target": "611" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, + "id": 1847, + "name": "ACTOR_BUILD_SUCCEEDED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", "flags": {}, - "groups": [], - "id": 670, - "module": "_models", - "name": "count", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1343 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Triggered when an Actor build completes successfully." } ] }, - "flags": {}, - "groups": [], - "id": 671, - "module": "_models", - "name": "limit", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1344 - } - ], "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 672, - "module": "_models", - "name": "exclusive_start_key", - "parsedDocstring": { - "text": "" + "type": "literal", + "value": "'ACTOR.BUILD.SUCCEEDED'" }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1345 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='exclusiveStartKey', examples=['some-key'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, "groups": [], - "id": 673, - "module": "_models", - "name": "is_truncated", - "parsedDocstring": { - "text": "" - }, "sources": [ { + "filename": "/src/apify_shared/consts.py", + "line": 306, "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1346 + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L306" } - ], - "type": { - "name": "bool", - "type": "reference" - } + ] }, { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, + "id": 1848, + "name": "ACTOR_BUILD_FAILED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", "flags": {}, - "groups": [], - "id": 674, - "module": "_models", - "name": "next_exclusive_start_key", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1347 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='nextExclusiveStartKey', examples=['third-key'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 670, - 672, - 673, - 669, - 671, - 668, - 674 - ], - "title": "Properties" - } - ], - "id": 667, - "module": "_models", - "name": "ListOfKeys", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1337 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], "comment": { "summary": [ { "kind": "text", - "text": "" + "text": "Triggered when an Actor build fails due to compilation or setup errors." } ] }, - "flags": {}, - "groups": [], - "id": 676, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1352 - } - ], "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 677, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1356 - } - ], - "type": { - "name": "ListOfKeys", - "type": "reference", - "target": "667" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 677, - 676 - ], - "title": "Properties" - } - ], - "id": 675, - "module": "_models", - "name": "ListOfKeysResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1351 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 679, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1363 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 680, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1367 - } - ], - "type": { - "name": "ListOfRequestQueues", - "type": "reference", - "target": "765" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response containing a list of request queues." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 680, - 679 - ], - "title": "Properties" - } - ], - "id": 678, - "module": "_models", - "name": "ListOfRequestQueuesResponse", - "parsedDocstring": { - "text": "Response containing a list of request queues." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1360 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 682, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1374 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The array of requests." - } - ] - }, - "flags": {}, - "groups": [], - "id": 683, - "module": "_models", - "name": "items", - "parsedDocstring": { - "text": "The array of requests." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1378 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Request", - "target": "876" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of requests returned in this response." - } - ] - }, - "flags": {}, - "groups": [], - "id": 684, - "module": "_models", - "name": "limit", - "parsedDocstring": { - "text": "The maximum number of requests returned in this response." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1382 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the last request from the previous page, used for pagination." - } - ] - }, - "flags": {}, - "groups": [], - "id": 685, - "module": "_models", - "name": "exclusive_start_id", - "parsedDocstring": { - "text": "The ID of the last request from the previous page, used for pagination." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1386 - } - ], - "type": { - "name": "Annotated[ str | None, Field(alias='exclusiveStartId', deprecated=True, examples=['Ihnsp8YrvJ8102Kj']) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A cursor string used for current page of results." - } - ] - }, - "flags": {}, - "groups": [], - "id": 686, - "module": "_models", - "name": "cursor", - "parsedDocstring": { - "text": "A cursor string used for current page of results." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1392 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['eyJyZXF1ZXN0SWQiOiI0SVlLUWFXZ2FKUUlWNlMifQ'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A cursor string to be used to continue pagination." - } - ] - }, - "flags": {}, - "groups": [], - "id": 687, - "module": "_models", - "name": "next_cursor", - "parsedDocstring": { - "text": "A cursor string to be used to continue pagination." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1396 - } - ], - "type": { - "name": "Annotated[ str | None, Field(alias='nextCursor', examples=['eyJyZXF1ZXN0SWQiOiI5eFNNc1BrN1J6VUxTNXoifQ']) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A paginated list of requests from the request queue." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 686, - 685, - 683, - 684, - 682, - 687 - ], - "title": "Properties" - } - ], - "id": 681, - "module": "_models", - "name": "ListOfRequests", - "parsedDocstring": { - "text": "A paginated list of requests from the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1371 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 689, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1408 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 690, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1412 - } - ], - "type": { - "name": "ListOfRequests", - "type": "reference", - "target": "681" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response containing a list of requests from the request queue." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 690, - 689 - ], - "title": "Properties" - } - ], - "id": 688, - "module": "_models", - "name": "ListOfRequestsResponse", - "parsedDocstring": { - "text": "Response containing a list of requests from the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1405 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 692, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1417 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 693, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1421 - } - ], - "type": { - "name": "ListOfRuns", - "type": "reference", - "target": "768" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 693, - 692 - ], - "title": "Properties" - } - ], - "id": 691, - "module": "_models", - "name": "ListOfRunsResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1416 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 695, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1426 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 696, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1430 - } - ], - "type": { - "name": "ListOfSchedules", - "type": "reference", - "target": "771" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 696, - 695 - ], - "title": "Properties" - } - ], - "id": 694, - "module": "_models", - "name": "ListOfSchedulesResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1425 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 698, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1435 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 699, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1439 - } - ], - "type": { - "name": "ListOfTasks", - "type": "reference", - "target": "777" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 699, - 698 - ], - "title": "Properties" - } - ], - "id": 697, - "module": "_models", - "name": "ListOfTasksResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1434 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 701, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1444 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 702, - "module": "_models", - "name": "total", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1448 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 703, - "module": "_models", - "name": "items", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1449 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Version", - "target": "1336" - } - ], - "target": "2199" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 703, - 701, - 702 - ], - "title": "Properties" - } - ], - "id": 700, - "module": "_models", - "name": "ListOfVersions", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1443 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 705, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1454 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 706, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1458 - } - ], - "type": { - "name": "ListOfVersions", - "type": "reference", - "target": "700" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 706, - 705 - ], - "title": "Properties" - } - ], - "id": 704, - "module": "_models", - "name": "ListOfVersionsResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1453 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 708, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1463 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 709, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1467 - } - ], - "type": { - "name": "ListOfWebhookDispatches", - "type": "reference", - "target": "780" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 709, - 708 - ], - "title": "Properties" - } - ], - "id": 707, - "module": "_models", - "name": "ListOfWebhookDispatchesResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1462 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 711, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1472 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 712, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1476 - } - ], - "type": { - "name": "ListOfWebhooks", - "type": "reference", - "target": "783" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 712, - 711 - ], - "title": "Properties" - } - ], - "id": 710, - "module": "_models", - "name": "ListOfWebhooksResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1471 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 714, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1483 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier assigned to the request." - } - ] - }, - "flags": {}, - "groups": [], - "id": 715, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1487 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - } - ] - }, - "flags": {}, - "groups": [], - "id": 716, - "module": "_models", - "name": "unique_key", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1491 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of the request." - } - ] - }, - "flags": {}, - "groups": [], - "id": 717, - "module": "_models", - "name": "url", - "parsedDocstring": { - "text": "The URL of the request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1495 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 718, - "module": "_models", - "name": "method", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1499 - } - ], - "type": { - "name": "HttpMethod | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "HttpMethod", - "target": "1798" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of times this request has been retried." - } - ] - }, - "flags": {}, - "groups": [], - "id": 719, - "module": "_models", - "name": "retry_count", - "parsedDocstring": { - "text": "The number of times this request has been retried." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1500 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='retryCount', examples=[0])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timestamp when the lock on this request expires." - } - ] - }, - "flags": {}, - "groups": [], - "id": 720, - "module": "_models", - "name": "lock_expires_at", - "parsedDocstring": { - "text": "The timestamp when the lock on this request expires." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1504 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A request from the request queue head that has been locked for processing." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 715, - 720, - 718, - 714, - 719, - 716, - 717 - ], - "title": "Properties" - } - ], - "id": 713, - "module": "_models", - "name": "LockedHeadRequest", - "parsedDocstring": { - "text": "A request from the request queue head that has been locked for processing." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1480 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 722, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1514 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of requests returned." - } - ] - }, - "flags": {}, - "groups": [], - "id": 723, - "module": "_models", - "name": "limit", - "parsedDocstring": { - "text": "The maximum number of requests returned." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1518 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 724, - "module": "_models", - "name": "queue_modified_at", - "parsedDocstring": { - "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1522 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the request queue contains requests locked by any client (either the one calling the endpoint or a different one)." - } - ] - }, - "flags": {}, - "groups": [], - "id": 725, - "module": "_models", - "name": "queue_has_locked_requests", - "parsedDocstring": { - "text": "Whether the request queue contains requests locked by any client (either the one calling the endpoint or a different one)." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1526 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='queueHasLockedRequests', examples=[True])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The client key used for locking the requests." - } - ] - }, - "flags": {}, - "groups": [], - "id": 726, - "module": "_models", - "name": "client_key", - "parsedDocstring": { - "text": "The client key used for locking the requests." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1530 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='clientKey', examples=['client-one'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the request queue has been accessed by multiple different clients." - } - ] - }, - "flags": {}, - "groups": [], - "id": 727, - "module": "_models", - "name": "had_multiple_clients", - "parsedDocstring": { - "text": "Whether the request queue has been accessed by multiple different clients." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1534 - } - ], - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of seconds the locks will be held." - } - ] - }, - "flags": {}, - "groups": [], - "id": 728, - "module": "_models", - "name": "lock_secs", - "parsedDocstring": { - "text": "The number of seconds the locks will be held." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1538 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The array of locked requests from the request queue head." - } - ] - }, - "flags": {}, - "groups": [], - "id": 729, - "module": "_models", - "name": "items", - "parsedDocstring": { - "text": "The array of locked requests from the request queue head." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1542 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "LockedHeadRequest", - "target": "713" - } - ], - "target": "2199" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A batch of locked requests from the request queue head." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 726, - 727, - 729, - 723, - 728, - 722, - 725, - 724 - ], - "title": "Properties" - } - ], - "id": 721, - "module": "_models", - "name": "LockedRequestQueueHead", - "parsedDocstring": { - "text": "A batch of locked requests from the request queue head." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1511 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 731, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1552 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Time when the metamorph occurred." - } - ] - }, - "flags": {}, - "groups": [], - "id": 732, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "Time when the metamorph occurred." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1556 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the Actor that the run was metamorphed to." - } - ] - }, - "flags": {}, - "groups": [], - "id": 733, - "module": "_models", - "name": "actor_id", - "parsedDocstring": { - "text": "ID of the Actor that the run was metamorphed to." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1560 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the build used for the metamorphed Actor." - } - ] - }, - "flags": {}, - "groups": [], - "id": 734, - "module": "_models", - "name": "build_id", - "parsedDocstring": { - "text": "ID of the build used for the metamorphed Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1564 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Key of the input record in the key-value store." - } - ] - }, - "flags": {}, - "groups": [], - "id": 735, - "module": "_models", - "name": "input_key", - "parsedDocstring": { - "text": "Key of the input record in the key-value store." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1568 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='inputKey', examples=['INPUT-METAMORPH-1'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Information about a metamorph event that occurred during the run." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 733, - 734, - 732, - 735, - 731 - ], - "title": "Properties" - } - ], - "id": 730, - "module": "_models", - "name": "Metamorph", - "parsedDocstring": { - "text": "Information about a metamorph event that occurred during the run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1549 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 737, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1576 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 738, - "module": "_models", - "name": "usage_cycle", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1580 - } - ], - "type": { - "name": "UsageCycle", - "type": "reference", - "target": "1303" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 739, - "module": "_models", - "name": "monthly_service_usage", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1581 - } - ], - "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "UsageItem", - "target": "1307" - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 740, - "module": "_models", - "name": "daily_service_usages", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1582 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "DailyServiceUsages", - "target": "427" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 741, - "module": "_models", - "name": "total_usage_credits_usd_before_volume_discount", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1583 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 742, - "module": "_models", - "name": "total_usage_credits_usd_after_volume_discount", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1586 - } - ], - "type": { - "name": "float", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 740, - 737, - 739, - 742, - 741, - 738 - ], - "title": "Properties" - } - ], - "id": 736, - "module": "_models", - "name": "MonthlyUsage", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1575 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 744, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1593 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 745, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1597 - } - ], - "type": { - "name": "MonthlyUsage", - "type": "reference", - "target": "736" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 745, - 744 - ], - "title": "Properties" - } - ], - "id": 743, - "module": "_models", - "name": "MonthlyUsageResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1592 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 747, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1604 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total number of items available across all pages." - } - ] - }, - "flags": {}, - "groups": [], - "id": 748, - "module": "_models", - "name": "total", - "parsedDocstring": { - "text": "The total number of items available across all pages." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1608 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting position for this page of results." - } - ] - }, - "flags": {}, - "groups": [], - "id": 749, - "module": "_models", - "name": "offset", - "parsedDocstring": { - "text": "The starting position for this page of results." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1612 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of items returned per page." - } - ] - }, - "flags": {}, - "groups": [], - "id": 750, - "module": "_models", - "name": "limit", - "parsedDocstring": { - "text": "The maximum number of items returned per page." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1616 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the results are sorted in descending order." - } - ] - }, - "flags": {}, - "groups": [], - "id": 751, - "module": "_models", - "name": "desc", - "parsedDocstring": { - "text": "Whether the results are sorted in descending order." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1620 - } - ], - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items returned in this response." - } - ] - }, - "flags": {}, - "groups": [], - "id": 752, - "module": "_models", - "name": "count", - "parsedDocstring": { - "text": "The number of items returned in this response." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1624 - } - ], - "type": { - "name": "int", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Common pagination fields for list responses." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 752, - 751, - 750, - 747, - 749, - 748 - ], - "title": "Properties" - } - ], - "id": 746, - "module": "_models", - "name": "PaginationResponse", - "parsedDocstring": { - "text": "Common pagination fields for list responses." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1601 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "ListOfActors", - "target": "753", - "type": "reference" - }, - { - "name": "ListOfBuilds", - "target": "756", - "type": "reference" - }, - { - "name": "ListOfDatasets", - "target": "759", - "type": "reference" - }, - { - "name": "ListOfKeyValueStores", - "target": "762", - "type": "reference" - }, - { - "name": "ListOfRequestQueues", - "target": "765", - "type": "reference" - }, - { - "name": "ListOfRuns", - "target": "768", - "type": "reference" - }, - { - "name": "ListOfSchedules", - "target": "771", - "type": "reference" - }, - { - "name": "ListOfStoreActors", - "target": "774", - "type": "reference" - }, - { - "name": "ListOfTasks", - "target": "777", - "type": "reference" - }, - { - "name": "ListOfWebhookDispatches", - "target": "780", - "type": "reference" - }, - { - "name": "ListOfWebhooks", - "target": "783", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 754, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1632 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "PaginationResponse.model_config", - "target": 747, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 755, - "module": "_models", - "name": "items", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1636 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ActorShort", - "target": "246" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total number of items available across all pages." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4061, - "module": "_models", - "name": "total", - "parsedDocstring": { - "text": "The total number of items available across all pages." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1608 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.total", - "target": 748, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting position for this page of results." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4062, - "module": "_models", - "name": "offset", - "parsedDocstring": { - "text": "The starting position for this page of results." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1612 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[0], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.offset", - "target": 749, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of items returned per page." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4063, - "module": "_models", - "name": "limit", - "parsedDocstring": { - "text": "The maximum number of items returned per page." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1616 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1000], ge=1)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.limit", - "target": 750, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the results are sorted in descending order." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4064, - "module": "_models", - "name": "desc", - "parsedDocstring": { - "text": "Whether the results are sorted in descending order." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1620 - } - ], - "type": { - "name": "Annotated[bool, Field(examples=[False])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.desc", - "target": 751, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items returned in this response." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4065, - "module": "_models", - "name": "count", - "parsedDocstring": { - "text": "The number of items returned in this response." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1624 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.count", - "target": 752, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4065, - 4064, - 755, - 4063, - 754, - 4062, - 4061 - ], - "title": "Properties" - } - ], - "id": 753, - "module": "_models", - "name": "ListOfActors", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1631 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "PaginationResponse", - "target": "746", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 757, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1641 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "PaginationResponse.model_config", - "target": 747, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 758, - "module": "_models", - "name": "items", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1645 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "BuildShort", - "target": "333" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total number of items available across all pages." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4066, - "module": "_models", - "name": "total", - "parsedDocstring": { - "text": "The total number of items available across all pages." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1608 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.total", - "target": 748, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting position for this page of results." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4067, - "module": "_models", - "name": "offset", - "parsedDocstring": { - "text": "The starting position for this page of results." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1612 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[0], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.offset", - "target": 749, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of items returned per page." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4068, - "module": "_models", - "name": "limit", - "parsedDocstring": { - "text": "The maximum number of items returned per page." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1616 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1000], ge=1)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.limit", - "target": 750, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the results are sorted in descending order." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4069, - "module": "_models", - "name": "desc", - "parsedDocstring": { - "text": "Whether the results are sorted in descending order." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1620 - } - ], - "type": { - "name": "Annotated[bool, Field(examples=[False])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.desc", - "target": 751, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items returned in this response." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4070, - "module": "_models", - "name": "count", - "parsedDocstring": { - "text": "The number of items returned in this response." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1624 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.count", - "target": 752, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4070, - 4069, - 758, - 4068, - 757, - 4067, - 4066 - ], - "title": "Properties" - } - ], - "id": 756, - "module": "_models", - "name": "ListOfBuilds", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1640 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "PaginationResponse", - "target": "746", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 760, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1650 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "PaginationResponse.model_config", - "target": 747, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 761, - "module": "_models", - "name": "items", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1654 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "DatasetListItem", - "target": "457" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total number of items available across all pages." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4071, - "module": "_models", - "name": "total", - "parsedDocstring": { - "text": "The total number of items available across all pages." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1608 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.total", - "target": 748, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting position for this page of results." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4072, - "module": "_models", - "name": "offset", - "parsedDocstring": { - "text": "The starting position for this page of results." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1612 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[0], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.offset", - "target": 749, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of items returned per page." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4073, - "module": "_models", - "name": "limit", - "parsedDocstring": { - "text": "The maximum number of items returned per page." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1616 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1000], ge=1)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.limit", - "target": 750, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the results are sorted in descending order." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4074, - "module": "_models", - "name": "desc", - "parsedDocstring": { - "text": "Whether the results are sorted in descending order." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1620 - } - ], - "type": { - "name": "Annotated[bool, Field(examples=[False])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.desc", - "target": 751, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items returned in this response." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4075, - "module": "_models", - "name": "count", - "parsedDocstring": { - "text": "The number of items returned in this response." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1624 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.count", - "target": 752, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4075, - 4074, - 761, - 4073, - 760, - 4072, - 4071 - ], - "title": "Properties" - } - ], - "id": 759, - "module": "_models", - "name": "ListOfDatasets", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1649 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "PaginationResponse", - "target": "746", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 763, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1659 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "PaginationResponse.model_config", - "target": 747, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 764, - "module": "_models", - "name": "items", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1663 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "KeyValueStore", - "target": "595" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total number of items available across all pages." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4076, - "module": "_models", - "name": "total", - "parsedDocstring": { - "text": "The total number of items available across all pages." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1608 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.total", - "target": 748, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting position for this page of results." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4077, - "module": "_models", - "name": "offset", - "parsedDocstring": { - "text": "The starting position for this page of results." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1612 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[0], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.offset", - "target": 749, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of items returned per page." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4078, - "module": "_models", - "name": "limit", - "parsedDocstring": { - "text": "The maximum number of items returned per page." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1616 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1000], ge=1)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.limit", - "target": 750, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the results are sorted in descending order." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4079, - "module": "_models", - "name": "desc", - "parsedDocstring": { - "text": "Whether the results are sorted in descending order." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1620 - } - ], - "type": { - "name": "Annotated[bool, Field(examples=[False])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.desc", - "target": 751, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items returned in this response." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4080, - "module": "_models", - "name": "count", - "parsedDocstring": { - "text": "The number of items returned in this response." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1624 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.count", - "target": 752, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4080, - 4079, - 764, - 4078, - 763, - 4077, - 4076 - ], - "title": "Properties" - } - ], - "id": 762, - "module": "_models", - "name": "ListOfKeyValueStores", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1658 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "PaginationResponse", - "target": "746", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 766, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1670 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "PaginationResponse.model_config", - "target": 747, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The array of request queues." - } - ] - }, - "flags": {}, - "groups": [], - "id": 767, - "module": "_models", - "name": "items", - "parsedDocstring": { - "text": "The array of request queues." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1674 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "RequestQueueShort", - "target": "922" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total number of items available across all pages." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4081, - "module": "_models", - "name": "total", - "parsedDocstring": { - "text": "The total number of items available across all pages." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1608 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.total", - "target": 748, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting position for this page of results." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4082, - "module": "_models", - "name": "offset", - "parsedDocstring": { - "text": "The starting position for this page of results." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1612 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[0], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.offset", - "target": 749, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of items returned per page." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4083, - "module": "_models", - "name": "limit", - "parsedDocstring": { - "text": "The maximum number of items returned per page." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1616 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1000], ge=1)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.limit", - "target": 750, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the results are sorted in descending order." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4084, - "module": "_models", - "name": "desc", - "parsedDocstring": { - "text": "Whether the results are sorted in descending order." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1620 - } - ], - "type": { - "name": "Annotated[bool, Field(examples=[False])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.desc", - "target": 751, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items returned in this response." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4085, - "module": "_models", - "name": "count", - "parsedDocstring": { - "text": "The number of items returned in this response." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1624 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.count", - "target": 752, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A paginated list of request queues." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4085, - 4084, - 767, - 4083, - 766, - 4082, - 4081 - ], - "title": "Properties" - } - ], - "id": 765, - "module": "_models", - "name": "ListOfRequestQueues", - "parsedDocstring": { - "text": "A paginated list of request queues." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1667 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "PaginationResponse", - "target": "746", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 769, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1682 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "PaginationResponse.model_config", - "target": 747, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 770, - "module": "_models", - "name": "items", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1686 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "RunShort", - "target": "1010" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total number of items available across all pages." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4086, - "module": "_models", - "name": "total", - "parsedDocstring": { - "text": "The total number of items available across all pages." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1608 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.total", - "target": 748, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting position for this page of results." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4087, - "module": "_models", - "name": "offset", - "parsedDocstring": { - "text": "The starting position for this page of results." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1612 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[0], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.offset", - "target": 749, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of items returned per page." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4088, - "module": "_models", - "name": "limit", - "parsedDocstring": { - "text": "The maximum number of items returned per page." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1616 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1000], ge=1)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.limit", - "target": 750, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the results are sorted in descending order." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4089, - "module": "_models", - "name": "desc", - "parsedDocstring": { - "text": "Whether the results are sorted in descending order." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1620 - } - ], - "type": { - "name": "Annotated[bool, Field(examples=[False])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.desc", - "target": 751, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items returned in this response." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4090, - "module": "_models", - "name": "count", - "parsedDocstring": { - "text": "The number of items returned in this response." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1624 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.count", - "target": 752, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4090, - 4089, - 770, - 4088, - 769, - 4087, - 4086 - ], - "title": "Properties" - } - ], - "id": 768, - "module": "_models", - "name": "ListOfRuns", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1681 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "PaginationResponse", - "target": "746", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 772, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1691 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "PaginationResponse.model_config", - "target": 747, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 773, - "module": "_models", - "name": "items", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1695 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ScheduleShort", - "target": "1152" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total number of items available across all pages." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4091, - "module": "_models", - "name": "total", - "parsedDocstring": { - "text": "The total number of items available across all pages." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1608 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.total", - "target": 748, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting position for this page of results." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4092, - "module": "_models", - "name": "offset", - "parsedDocstring": { - "text": "The starting position for this page of results." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1612 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[0], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.offset", - "target": 749, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of items returned per page." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4093, - "module": "_models", - "name": "limit", - "parsedDocstring": { - "text": "The maximum number of items returned per page." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1616 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1000], ge=1)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.limit", - "target": 750, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the results are sorted in descending order." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4094, - "module": "_models", - "name": "desc", - "parsedDocstring": { - "text": "Whether the results are sorted in descending order." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1620 - } - ], - "type": { - "name": "Annotated[bool, Field(examples=[False])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.desc", - "target": 751, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items returned in this response." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4095, - "module": "_models", - "name": "count", - "parsedDocstring": { - "text": "The number of items returned in this response." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1624 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.count", - "target": 752, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4095, - 4094, - 773, - 4093, - 772, - 4092, - 4091 - ], - "title": "Properties" - } - ], - "id": 771, - "module": "_models", - "name": "ListOfSchedules", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1690 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "PaginationResponse", - "target": "746", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 775, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1700 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "PaginationResponse.model_config", - "target": 747, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 776, - "module": "_models", - "name": "items", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1704 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "StoreListActor", - "target": "1175" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total number of items available across all pages." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4096, - "module": "_models", - "name": "total", - "parsedDocstring": { - "text": "The total number of items available across all pages." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1608 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.total", - "target": 748, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting position for this page of results." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4097, - "module": "_models", - "name": "offset", - "parsedDocstring": { - "text": "The starting position for this page of results." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1612 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[0], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.offset", - "target": 749, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of items returned per page." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4098, - "module": "_models", - "name": "limit", - "parsedDocstring": { - "text": "The maximum number of items returned per page." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1616 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1000], ge=1)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.limit", - "target": 750, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the results are sorted in descending order." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4099, - "module": "_models", - "name": "desc", - "parsedDocstring": { - "text": "Whether the results are sorted in descending order." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1620 - } - ], - "type": { - "name": "Annotated[bool, Field(examples=[False])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.desc", - "target": 751, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items returned in this response." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4100, - "module": "_models", - "name": "count", - "parsedDocstring": { - "text": "The number of items returned in this response." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1624 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.count", - "target": 752, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4100, - 4099, - 776, - 4098, - 775, - 4097, - 4096 - ], - "title": "Properties" - } - ], - "id": 774, - "module": "_models", - "name": "ListOfStoreActors", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1699 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "PaginationResponse", - "target": "746", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 778, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1709 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "PaginationResponse.model_config", - "target": 747, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 779, - "module": "_models", - "name": "items", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1713 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "TaskShort", - "target": "1226" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total number of items available across all pages." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4101, - "module": "_models", - "name": "total", - "parsedDocstring": { - "text": "The total number of items available across all pages." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1608 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.total", - "target": 748, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting position for this page of results." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4102, - "module": "_models", - "name": "offset", - "parsedDocstring": { - "text": "The starting position for this page of results." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1612 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[0], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.offset", - "target": 749, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of items returned per page." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4103, - "module": "_models", - "name": "limit", - "parsedDocstring": { - "text": "The maximum number of items returned per page." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1616 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1000], ge=1)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.limit", - "target": 750, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the results are sorted in descending order." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4104, - "module": "_models", - "name": "desc", - "parsedDocstring": { - "text": "Whether the results are sorted in descending order." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1620 - } - ], - "type": { - "name": "Annotated[bool, Field(examples=[False])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.desc", - "target": 751, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items returned in this response." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4105, - "module": "_models", - "name": "count", - "parsedDocstring": { - "text": "The number of items returned in this response." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1624 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.count", - "target": 752, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4105, - 4104, - 779, - 4103, - 778, - 4102, - 4101 - ], - "title": "Properties" - } - ], - "id": 777, - "module": "_models", - "name": "ListOfTasks", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1708 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "PaginationResponse", - "target": "746", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 781, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1718 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "PaginationResponse.model_config", - "target": 747, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 782, - "module": "_models", - "name": "items", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1722 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookDispatch", - "target": "1386" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total number of items available across all pages." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4106, - "module": "_models", - "name": "total", - "parsedDocstring": { - "text": "The total number of items available across all pages." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1608 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.total", - "target": 748, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting position for this page of results." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4107, - "module": "_models", - "name": "offset", - "parsedDocstring": { - "text": "The starting position for this page of results." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1612 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[0], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.offset", - "target": 749, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of items returned per page." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4108, - "module": "_models", - "name": "limit", - "parsedDocstring": { - "text": "The maximum number of items returned per page." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1616 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1000], ge=1)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.limit", - "target": 750, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the results are sorted in descending order." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4109, - "module": "_models", - "name": "desc", - "parsedDocstring": { - "text": "Whether the results are sorted in descending order." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1620 - } - ], - "type": { - "name": "Annotated[bool, Field(examples=[False])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.desc", - "target": 751, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items returned in this response." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4110, - "module": "_models", - "name": "count", - "parsedDocstring": { - "text": "The number of items returned in this response." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1624 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.count", - "target": 752, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4110, - 4109, - 782, - 4108, - 781, - 4107, - 4106 - ], - "title": "Properties" - } - ], - "id": 780, - "module": "_models", - "name": "ListOfWebhookDispatches", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1717 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "PaginationResponse", - "target": "746", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 784, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1727 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "PaginationResponse.model_config", - "target": 747, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 785, - "module": "_models", - "name": "items", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1731 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookShort", - "target": "1406" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total number of items available across all pages." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4111, - "module": "_models", - "name": "total", - "parsedDocstring": { - "text": "The total number of items available across all pages." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1608 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.total", - "target": 748, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The starting position for this page of results." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4112, - "module": "_models", - "name": "offset", - "parsedDocstring": { - "text": "The starting position for this page of results." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1612 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[0], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.offset", - "target": 749, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of items returned per page." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4113, - "module": "_models", - "name": "limit", - "parsedDocstring": { - "text": "The maximum number of items returned per page." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1616 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1000], ge=1)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.limit", - "target": 750, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the results are sorted in descending order." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4114, - "module": "_models", - "name": "desc", - "parsedDocstring": { - "text": "Whether the results are sorted in descending order." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1620 - } - ], - "type": { - "name": "Annotated[bool, Field(examples=[False])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.desc", - "target": 751, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items returned in this response." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4115, - "module": "_models", - "name": "count", - "parsedDocstring": { - "text": "The number of items returned in this response." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1624 - } - ], - "type": { - "name": "Annotated[int, Field(examples=[1], ge=0)]", - "type": "reference" - }, - "inheritedFrom": { - "name": "PaginationResponse.count", - "target": 752, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4115, - 4114, - 785, - 4113, - 784, - 4112, - 4111 - ], - "title": "Properties" - } - ], - "id": 783, - "module": "_models", - "name": "ListOfWebhooks", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1726 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "PaginationResponse", - "target": "746", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 787, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1736 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "CommonActorPricingInfo.model_config", - "target": 370, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 788, - "module": "_models", - "name": "pricing_model", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1740 - } - ], - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "PAY_PER_EVENT" - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 789, - "module": "_models", - "name": "pricing_per_event", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1741 - } - ], - "type": { - "name": "PricingPerEvent", - "type": "reference", - "target": "825" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 790, - "module": "_models", - "name": "minimal_max_total_charge_usd", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1742 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='minimalMaxTotalChargeUsd')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4128, - "module": "_models", - "name": "apify_margin_percentage", - "parsedDocstring": { - "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 518 - } - ], - "type": { - "name": "Annotated[float, Field(alias='apifyMarginPercentage')]", - "type": "reference" - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.apify_margin_percentage", - "target": 371, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "When this pricing info record has been created" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4129, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "When this pricing info record has been created" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 522 - } - ], - "type": { - "name": "Annotated[AwareDatetime, Field(alias='createdAt')]", - "type": "reference" - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.created_at", - "target": 372, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Since when is this pricing info record effective for a given Actor" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4130, - "module": "_models", - "name": "started_at", - "parsedDocstring": { - "text": "Since when is this pricing info record effective for a given Actor" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 526 - } - ], - "type": { - "name": "Annotated[AwareDatetime, Field(alias='startedAt')]", - "type": "reference" - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.started_at", - "target": 373, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4131, - "module": "_models", - "name": "notified_about_future_change_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 530 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutFutureChangeAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.notified_about_future_change_at", - "target": 374, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4132, - "module": "_models", - "name": "notified_about_change_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 531 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutChangeAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.notified_about_change_at", - "target": 375, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4133, - "module": "_models", - "name": "reason_for_change", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 532 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='reasonForChange')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.reason_for_change", - "target": 376, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4128, - 4129, - 790, - 787, - 4132, - 4131, - 788, - 789, - 4133, - 4130 - ], - "title": "Properties" - } - ], - "id": 786, - "module": "_models", - "name": "PayPerEventActorPricingInfo", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1735 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "CommonActorPricingInfo", - "target": "369", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 792, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1747 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 793, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1751 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 794, - "module": "_models", - "name": "description", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1752 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 795, - "module": "_models", - "name": "is_enabled", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1753 - } - ], - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 796, - "module": "_models", - "name": "monthly_base_price_usd", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1754 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 797, - "module": "_models", - "name": "monthly_usage_credits_usd", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1755 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 798, - "module": "_models", - "name": "usage_discount_percent", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1756 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='usageDiscountPercent', examples=[0])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 799, - "module": "_models", - "name": "enabled_platform_features", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1757 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 800, - "module": "_models", - "name": "max_monthly_usage_usd", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1763 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 801, - "module": "_models", - "name": "max_actor_memory_gbytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1764 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 802, - "module": "_models", - "name": "max_monthly_actor_compute_units", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1765 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 803, - "module": "_models", - "name": "max_monthly_residential_proxy_gbytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1766 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 804, - "module": "_models", - "name": "max_monthly_proxy_serps", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1769 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 805, - "module": "_models", - "name": "max_monthly_external_data_transfer_gbytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1770 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 806, - "module": "_models", - "name": "max_actor_count", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1773 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 807, - "module": "_models", - "name": "max_actor_task_count", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1774 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 808, - "module": "_models", - "name": "data_retention_days", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1775 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of available proxies in this group." - } - ] - }, - "flags": {}, - "groups": [], - "id": 809, - "module": "_models", - "name": "available_proxy_groups", - "parsedDocstring": { - "text": "The number of available proxies in this group." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1776 - } - ], - "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "int" - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 810, - "module": "_models", - "name": "team_account_seat_count", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1780 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 811, - "module": "_models", - "name": "support_level", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1781 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 812, - "module": "_models", - "name": "available_add_ons", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1782 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 812, - 809, - 808, - 794, - 799, - 793, - 795, - 806, - 801, - 807, - 802, - 805, - 804, - 803, - 800, - 792, - 796, - 797, - 811, - 810, - 798 - ], - "title": "Properties" - } - ], - "id": 791, - "module": "_models", - "name": "Plan", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1746 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 814, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1787 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "CommonActorPricingInfo.model_config", - "target": 370, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 815, - "module": "_models", - "name": "pricing_model", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1791 - } - ], - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "PRICE_PER_DATASET_ITEM" - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the unit that is being charged" - } - ] - }, - "flags": {}, - "groups": [], - "id": 816, - "module": "_models", - "name": "unit_name", - "parsedDocstring": { - "text": "Name of the unit that is being charged" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1792 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 817, - "module": "_models", - "name": "price_per_unit_usd", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1796 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4134, - "module": "_models", - "name": "apify_margin_percentage", - "parsedDocstring": { - "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 518 - } - ], - "type": { - "name": "Annotated[float, Field(alias='apifyMarginPercentage')]", - "type": "reference" - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.apify_margin_percentage", - "target": 371, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "When this pricing info record has been created" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4135, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "When this pricing info record has been created" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 522 - } - ], - "type": { - "name": "Annotated[AwareDatetime, Field(alias='createdAt')]", - "type": "reference" - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.created_at", - "target": 372, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Since when is this pricing info record effective for a given Actor" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4136, - "module": "_models", - "name": "started_at", - "parsedDocstring": { - "text": "Since when is this pricing info record effective for a given Actor" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 526 - } - ], - "type": { - "name": "Annotated[AwareDatetime, Field(alias='startedAt')]", - "type": "reference" - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.started_at", - "target": 373, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4137, - "module": "_models", - "name": "notified_about_future_change_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 530 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutFutureChangeAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.notified_about_future_change_at", - "target": 374, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4138, - "module": "_models", - "name": "notified_about_change_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 531 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutChangeAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.notified_about_change_at", - "target": 375, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4139, - "module": "_models", - "name": "reason_for_change", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 532 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='reasonForChange')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "CommonActorPricingInfo.reason_for_change", - "target": 376, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4134, - 4135, - 814, - 4138, - 4137, - 817, - 815, - 4139, - 4136, - 816 - ], - "title": "Properties" - } - ], - "id": 813, - "module": "_models", - "name": "PricePerDatasetItemActorPricingInfo", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1786 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "CommonActorPricingInfo", - "target": "369", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 819, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1801 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 820, - "module": "_models", - "name": "quantity_above", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1805 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 821, - "module": "_models", - "name": "discount_percent", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1806 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 822, - "module": "_models", - "name": "tier_quantity", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1807 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 823, - "module": "_models", - "name": "unit_price_usd", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1808 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 824, - "module": "_models", - "name": "price_usd", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1809 - } - ], - "type": { - "name": "float", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 821, - 819, - 824, - 820, - 822, - 823 - ], - "title": "Properties" - } - ], - "id": 818, - "module": "_models", - "name": "PriceTiers", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1800 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 826, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1814 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 827, - "module": "_models", - "name": "actor_charge_events", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1818 - } - ], - "type": { - "name": "Annotated[dict[str, ActorChargeEvent] | None, Field(alias='actorChargeEvents')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "ActorChargeEvent", - "target": "215" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 827, - 826 - ], - "title": "Properties" - } - ], - "id": 825, - "module": "_models", - "name": "PricingPerEvent", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1813 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 829, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1823 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 830, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1827 - } - ], - "type": { - "name": "UserPrivateInfo", - "type": "reference", - "target": "1314" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 830, - 829 - ], - "title": "Properties" - } - ], - "id": 828, - "module": "_models", - "name": "PrivateUserDataResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1822 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 832, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1832 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 833, - "module": "_models", - "name": "bio", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1836 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['I started web scraping in 1985 using Altair BASIC.'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 834, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1837 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['Jane Doe'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 835, - "module": "_models", - "name": "picture_url", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1838 - } - ], - "type": { - "name": "Annotated[ AnyUrl | None, Field(alias='pictureUrl', examples=['https://apify.com/img/anonymous_user_picture.png']) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AnyUrl" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 836, - "module": "_models", - "name": "github_username", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1841 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='githubUsername', examples=['torvalds.'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 837, - "module": "_models", - "name": "website_url", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1842 - } - ], - "type": { - "name": "Annotated[AnyUrl | None, Field(alias='websiteUrl', examples=['http://www.example.com'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AnyUrl" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 838, - "module": "_models", - "name": "twitter_username", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1843 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='twitterUsername', examples=['@BillGates'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 833, - 836, - 832, - 834, - 835, - 838, - 837 - ], - "title": "Properties" - } - ], - "id": 831, - "module": "_models", - "name": "Profile", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1831 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 840, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1850 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 841, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1854 - } - ], - "type": { - "name": "RequestLockInfo", - "type": "reference", - "target": "895" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response containing updated lock information after prolonging a request lock." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 841, - 840 - ], - "title": "Properties" - } - ], - "id": 839, - "module": "_models", - "name": "ProlongRequestLockResponse", - "parsedDocstring": { - "text": "Response containing updated lock information after prolonging a request lock." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1847 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 843, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1859 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 844, - "module": "_models", - "name": "password", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1863 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 845, - "module": "_models", - "name": "groups", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1864 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ProxyGroup", - "target": "846" - } - ], - "target": "2199" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 845, - 843, - 844 - ], - "title": "Properties" - } - ], - "id": 842, - "module": "_models", - "name": "Proxy", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1858 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 847, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1869 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 848, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1873 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 849, - "module": "_models", - "name": "description", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1874 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 850, - "module": "_models", - "name": "available_count", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1875 - } - ], - "type": { - "name": "int", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 850, - 849, - 847, - 848 - ], - "title": "Properties" - } - ], - "id": 846, - "module": "_models", - "name": "ProxyGroup", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1868 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 852, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1880 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 853, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1884 - } - ], - "type": { - "name": "UserPublicInfo", - "type": "reference", - "target": "1325" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 853, - 852 - ], - "title": "Properties" - } - ], - "id": 851, - "module": "_models", - "name": "PublicUserDataResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1879 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 855, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1889 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 856, - "module": "_models", - "name": "error", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1893 - } - ], - "type": { - "name": "DatasetSchemaValidationError", - "type": "reference", - "target": "472" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 856, - 855 - ], - "title": "Properties" - } - ], - "id": 854, - "module": "_models", - "name": "PutItemResponseError", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1888 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 858, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1903 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The request body containing the item(s) to add to the dataset. Can be a single\nobject or an array of objects. Each object represents one dataset item." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 858 - ], - "title": "Properties" - } - ], - "id": 857, - "module": "_models", - "name": "PutItemsRequest", - "parsedDocstring": { - "text": "The request body containing the item(s) to add to the dataset. Can be a single\nobject or an array of objects. Each object represents one dataset item." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1897 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 860, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1916 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The request body contains the value to store in the record. The content type\nshould be specified in the Content-Type header." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 860 - ], - "title": "Properties" - } - ], - "id": 859, - "module": "_models", - "name": "PutRecordRequest", - "parsedDocstring": { - "text": "The request body contains the value to store in the record. The content type\nshould be specified in the Content-Type header." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1910 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 862, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1929 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The response body contains the value of the record. The content type of the response\nis determined by the Content-Type header stored with the record." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 862 - ], - "title": "Properties" - } - ], - "id": 861, - "module": "_models", - "name": "RecordResponse", - "parsedDocstring": { - "text": "The response body contains the value of the record. The content type of the response\nis determined by the Content-Type header stored with the record." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1923 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 864, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1937 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - } - ] - }, - "flags": {}, - "groups": [], - "id": 865, - "module": "_models", - "name": "unique_key", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1941 - } - ], - "type": { - "name": "Annotated[ str | None, Field(alias='uniqueKey', examples=['GET|60d83e70|e3b0c442|https://apify.com']) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of the request." - } - ] - }, - "flags": {}, - "groups": [], - "id": 866, - "module": "_models", - "name": "url", - "parsedDocstring": { - "text": "The URL of the request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1947 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['https://apify.com'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 867, - "module": "_models", - "name": "method", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1951 - } - ], - "type": { - "name": "HttpMethod | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "HttpMethod", - "target": "1798" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of times this request has been retried." - } - ] - }, - "flags": {}, - "groups": [], - "id": 868, - "module": "_models", - "name": "retry_count", - "parsedDocstring": { - "text": "The number of times this request has been retried." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1952 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='retryCount', examples=[0])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The final URL that was loaded, after redirects (if any)." - } - ] - }, - "flags": {}, - "groups": [], - "id": 869, - "module": "_models", - "name": "loaded_url", - "parsedDocstring": { - "text": "The final URL that was loaded, after redirects (if any)." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1956 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='loadedUrl', examples=['https://apify.com/jobs'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The request payload, typically used with POST or PUT requests." - } - ] - }, - "flags": {}, - "groups": [], - "id": 870, - "module": "_models", - "name": "payload", - "parsedDocstring": { - "text": "The request payload, typically used with POST or PUT requests." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1960 - } - ], - "type": { - "name": "Annotated[str | dict[str, Any] | None, Field(examples=[None])]", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP headers sent with the request." - } - ] - }, - "flags": {}, - "groups": [], - "id": 871, - "module": "_models", - "name": "headers", - "parsedDocstring": { - "text": "HTTP headers sent with the request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1964 - } - ], - "type": { - "name": "Annotated[dict[str, Any] | None, Field(examples=[None])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 872, - "module": "_models", - "name": "user_data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1968 - } - ], - "type": { - "name": "Annotated[RequestUserData | None, Field(alias='userData')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestUserData", - "target": "956" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Indicates whether the request should not be retried if processing fails." - } - ] - }, - "flags": {}, - "groups": [], - "id": 873, - "module": "_models", - "name": "no_retry", - "parsedDocstring": { - "text": "Indicates whether the request should not be retried if processing fails." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1969 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='noRetry', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error messages recorded from failed processing attempts." - } - ] - }, - "flags": {}, - "groups": [], - "id": 874, - "module": "_models", - "name": "error_messages", - "parsedDocstring": { - "text": "Error messages recorded from failed processing attempts." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1973 - } - ], - "type": { - "name": "Annotated[list[str] | None, Field(alias='errorMessages', examples=[None])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timestamp when the request was marked as handled, if applicable." - } - ] - }, - "flags": {}, - "groups": [], - "id": 875, - "module": "_models", - "name": "handled_at", - "parsedDocstring": { - "text": "The timestamp when the request was marked as handled, if applicable." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1977 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='handledAt', examples=['2019-06-16T10:23:31.607Z'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 874, - 875, - 871, - 869, - 867, - 864, - 873, - 870, - 868, - 865, - 866, - 872 - ], - "title": "Properties" - } - ], - "id": 863, - "module": "_models", - "name": "RequestBase", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1936 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "Request", - "target": "876", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 877, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1987 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "RequestBase.model_config", - "target": 864, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier assigned to the request." - } - ] - }, - "flags": {}, - "groups": [], - "id": 878, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1991 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['sbJ7klsdf7ujN9l'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4050, - "module": "_models", - "name": "unique_key", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1941 - } - ], - "type": { - "name": "Annotated[ str | None, Field(alias='uniqueKey', examples=['GET|60d83e70|e3b0c442|https://apify.com']) ]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBase.unique_key", - "target": 865, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of the request." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4051, - "module": "_models", - "name": "url", - "parsedDocstring": { - "text": "The URL of the request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1947 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['https://apify.com'])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBase.url", - "target": 866, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4052, - "module": "_models", - "name": "method", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1951 - } - ], - "type": { - "name": "HttpMethod | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "HttpMethod", - "target": "1798" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "RequestBase.method", - "target": 867, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of times this request has been retried." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4053, - "module": "_models", - "name": "retry_count", - "parsedDocstring": { - "text": "The number of times this request has been retried." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1952 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='retryCount', examples=[0])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBase.retry_count", - "target": 868, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The final URL that was loaded, after redirects (if any)." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4054, - "module": "_models", - "name": "loaded_url", - "parsedDocstring": { - "text": "The final URL that was loaded, after redirects (if any)." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1956 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='loadedUrl', examples=['https://apify.com/jobs'])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBase.loaded_url", - "target": 869, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The request payload, typically used with POST or PUT requests." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4055, - "module": "_models", - "name": "payload", - "parsedDocstring": { - "text": "The request payload, typically used with POST or PUT requests." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1960 - } - ], - "type": { - "name": "Annotated[str | dict[str, Any] | None, Field(examples=[None])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBase.payload", - "target": 870, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP headers sent with the request." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4056, - "module": "_models", - "name": "headers", - "parsedDocstring": { - "text": "HTTP headers sent with the request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1964 - } - ], - "type": { - "name": "Annotated[dict[str, Any] | None, Field(examples=[None])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBase.headers", - "target": 871, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4057, - "module": "_models", - "name": "user_data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1968 - } - ], - "type": { - "name": "Annotated[RequestUserData | None, Field(alias='userData')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestUserData", - "target": "956" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "RequestBase.user_data", - "target": 872, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Indicates whether the request should not be retried if processing fails." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4058, - "module": "_models", - "name": "no_retry", - "parsedDocstring": { - "text": "Indicates whether the request should not be retried if processing fails." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1969 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='noRetry', examples=[False])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBase.no_retry", - "target": 873, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Error messages recorded from failed processing attempts." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4059, - "module": "_models", - "name": "error_messages", - "parsedDocstring": { - "text": "Error messages recorded from failed processing attempts." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1973 - } - ], - "type": { - "name": "Annotated[list[str] | None, Field(alias='errorMessages', examples=[None])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBase.error_messages", - "target": 874, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timestamp when the request was marked as handled, if applicable." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4060, - "module": "_models", - "name": "handled_at", - "parsedDocstring": { - "text": "The timestamp when the request was marked as handled, if applicable." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1977 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='handledAt', examples=['2019-06-16T10:23:31.607Z'])]", - "type": "reference" - }, - "inheritedFrom": { - "name": "RequestBase.handled_at", - "target": 875, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A request stored in the request queue, including its metadata and processing state." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4059, - 4060, - 4056, - 878, - 4054, - 4052, - 877, - 4058, - 4055, - 4053, - 4050, - 4051, - 4057 - ], - "title": "Properties" - } - ], - "id": 876, - "module": "_models", - "name": "Request", - "parsedDocstring": { - "text": "A request stored in the request queue, including its metadata and processing state." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1984 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "RequestBase", - "target": "863", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 880, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2001 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier assigned to the request." - } - ] - }, - "flags": {}, - "groups": [], - "id": 881, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2005 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['sbJ7klsdf7ujN9l'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - } - ] - }, - "flags": {}, - "groups": [], - "id": 882, - "module": "_models", - "name": "unique_key", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2009 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of the request." - } - ] - }, - "flags": {}, - "groups": [], - "id": 883, - "module": "_models", - "name": "url", - "parsedDocstring": { - "text": "The URL of the request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2013 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 884, - "module": "_models", - "name": "method", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2017 - } - ], - "type": { - "name": "HttpMethod | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "HttpMethod", - "target": "1798" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A request that failed to be processed during a request queue operation and can be retried." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 881, - 884, - 880, - 882, - 883 - ], - "title": "Properties" - } - ], - "id": 879, - "module": "_models", - "name": "RequestDraft", - "parsedDocstring": { - "text": "A request that failed to be processed during a request queue operation and can be retried." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1998 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 886, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2024 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier assigned to the request." - } - ] - }, - "flags": {}, - "groups": [], - "id": 887, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2028 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - } - ] - }, - "flags": {}, - "groups": [], - "id": 888, - "module": "_models", - "name": "unique_key", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2032 - } - ], - "type": { - "name": "Annotated[ str | None, Field(alias='uniqueKey', examples=['GET|60d83e70|e3b0c442|https://apify.com']) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A request that should be deleted, identified by its ID." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 887, - 886, - 888 - ], - "title": "Properties" - } - ], - "id": 885, - "module": "_models", - "name": "RequestDraftDeleteById", - "parsedDocstring": { - "text": "A request that should be deleted, identified by its ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2021 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 890, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2044 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier assigned to the request." - } - ] - }, - "flags": {}, - "groups": [], - "id": 891, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2048 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['sbJ7klsdf7ujN9l'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - } - ] - }, - "flags": {}, - "groups": [], - "id": 892, - "module": "_models", - "name": "unique_key", - "parsedDocstring": { - "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2052 - } - ], - "type": { - "name": "str", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A request that should be deleted, identified by its unique key." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 891, - 890, - 892 - ], - "title": "Properties" - } - ], - "id": 889, - "module": "_models", - "name": "RequestDraftDeleteByUniqueKey", - "parsedDocstring": { - "text": "A request that should be deleted, identified by its unique key." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2041 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A request that should be deleted." - } - ] - }, - "flags": {}, - "groups": [], - "id": 894, - "module": "_models", - "name": "root", - "parsedDocstring": { - "text": "A request that should be deleted." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2060 - } - ], - "type": { - "name": "Annotated[RequestDraftDeleteById | RequestDraftDeleteByUniqueKey, Field(title='RequestDraftDelete')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestDraftDeleteById", - "target": "885" - }, - { - "type": "reference", - "name": "RequestDraftDeleteByUniqueKey", - "target": "889" - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 894 - ], - "title": "Properties" - } - ], - "id": 893, - "module": "_models", - "name": "RequestDraftDelete", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2059 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 896, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2070 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timestamp when the lock on this request expires." - } - ] - }, - "flags": {}, - "groups": [], - "id": 897, - "module": "_models", - "name": "lock_expires_at", - "parsedDocstring": { - "text": "The timestamp when the lock on this request expires." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2074 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Information about a request lock." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 897, - 896 - ], - "title": "Properties" - } - ], - "id": 895, - "module": "_models", - "name": "RequestLockInfo", - "parsedDocstring": { - "text": "Information about a request lock." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2067 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 899, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2084 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier assigned to the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 900, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2088 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 901, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "The name of the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2092 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['some-name'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the user who owns the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 902, - "module": "_models", - "name": "user_id", - "parsedDocstring": { - "text": "The ID of the user who owns the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2096 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timestamp when the request queue was created." - } - ] - }, - "flags": {}, - "groups": [], - "id": 903, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "The timestamp when the request queue was created." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2100 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 904, - "module": "_models", - "name": "modified_at", - "parsedDocstring": { - "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2104 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timestamp when the request queue was last accessed." - } - ] - }, - "flags": {}, - "groups": [], - "id": 905, - "module": "_models", - "name": "accessed_at", - "parsedDocstring": { - "text": "The timestamp when the request queue was last accessed." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2108 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total number of requests in the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 906, - "module": "_models", - "name": "total_request_count", - "parsedDocstring": { - "text": "The total number of requests in the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2112 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of requests that have been handled." - } - ] - }, - "flags": {}, - "groups": [], - "id": 907, - "module": "_models", - "name": "handled_request_count", - "parsedDocstring": { - "text": "The number of requests that have been handled." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2116 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of requests that are pending and have not been handled yet." - } - ] - }, - "flags": {}, - "groups": [], - "id": 908, - "module": "_models", - "name": "pending_request_count", - "parsedDocstring": { - "text": "The number of requests that are pending and have not been handled yet." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2120 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the request queue has been accessed by multiple different clients." - } - ] - }, - "flags": {}, - "groups": [], - "id": 909, - "module": "_models", - "name": "had_multiple_clients", - "parsedDocstring": { - "text": "Whether the request queue has been accessed by multiple different clients." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2124 - } - ], - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL to view the request queue in the Apify console." - } - ] - }, - "flags": {}, - "groups": [], - "id": 910, - "module": "_models", - "name": "console_url", - "parsedDocstring": { - "text": "The URL to view the request queue in the Apify console." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2128 - } - ], - "type": { - "name": "AnyUrl", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 911, - "module": "_models", - "name": "stats", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2134 - } - ], - "type": { - "name": "RequestQueueStats | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestQueueStats", - "target": "938" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 912, - "module": "_models", - "name": "general_access", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2135 - } - ], - "type": { - "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "GeneralAccess", - "target": "1797" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A request queue object containing metadata and statistics." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 905, - 910, - 903, - 912, - 909, - 907, - 900, - 899, - 904, - 901, - 908, - 911, - 906, - 902 - ], - "title": "Properties" - } - ], - "id": 898, - "module": "_models", - "name": "RequestQueue", - "parsedDocstring": { - "text": "A request queue object containing metadata and statistics." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2081 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 914, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2142 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of requests returned." - } - ] - }, - "flags": {}, - "groups": [], - "id": 915, - "module": "_models", - "name": "limit", - "parsedDocstring": { - "text": "The maximum number of requests returned." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2146 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 916, - "module": "_models", - "name": "queue_modified_at", - "parsedDocstring": { - "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2150 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the request queue has been accessed by multiple different clients." - } - ] - }, - "flags": {}, - "groups": [], - "id": 917, - "module": "_models", - "name": "had_multiple_clients", - "parsedDocstring": { - "text": "Whether the request queue has been accessed by multiple different clients." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2154 - } - ], - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The array of requests from the request queue head." - } - ] - }, - "flags": {}, - "groups": [], - "id": 918, - "module": "_models", - "name": "items", - "parsedDocstring": { - "text": "The array of requests from the request queue head." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2158 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "HeadRequest", - "target": "581" - } - ], - "target": "2199" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A batch of requests from the request queue head without locking." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 917, - 918, - 915, - 914, - 916 - ], - "title": "Properties" - } - ], - "id": 913, - "module": "_models", - "name": "RequestQueueHead", - "parsedDocstring": { - "text": "A batch of requests from the request queue head without locking." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2139 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 920, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2168 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 921, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2172 - } - ], - "type": { - "name": "RequestQueue", - "type": "reference", - "target": "898" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response containing request queue data." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 921, - 920 - ], - "title": "Properties" - } - ], - "id": 919, - "module": "_models", - "name": "RequestQueueResponse", - "parsedDocstring": { - "text": "Response containing request queue data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2165 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 923, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2179 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier assigned to the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 924, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2183 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 925, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "The name of the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2187 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the user who owns the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 926, - "module": "_models", - "name": "user_id", - "parsedDocstring": { - "text": "The ID of the user who owns the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2191 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The username of the user who owns the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 927, - "module": "_models", - "name": "username", - "parsedDocstring": { - "text": "The username of the user who owns the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2195 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timestamp when the request queue was created." - } - ] - }, - "flags": {}, - "groups": [], - "id": 928, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "The timestamp when the request queue was created." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2199 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 929, - "module": "_models", - "name": "modified_at", - "parsedDocstring": { - "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2203 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timestamp when the request queue was last accessed." - } - ] - }, - "flags": {}, - "groups": [], - "id": 930, - "module": "_models", - "name": "accessed_at", - "parsedDocstring": { - "text": "The timestamp when the request queue was last accessed." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2207 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timestamp when the request queue will expire and be deleted." - } - ] - }, - "flags": {}, - "groups": [], - "id": 931, - "module": "_models", - "name": "expire_at", - "parsedDocstring": { - "text": "The timestamp when the request queue will expire and be deleted." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2211 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='expireAt', examples=['2019-06-02T17:15:06.751Z'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total number of requests in the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 932, - "module": "_models", - "name": "total_request_count", - "parsedDocstring": { - "text": "The total number of requests in the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2215 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of requests that have been handled." - } - ] - }, - "flags": {}, - "groups": [], - "id": 933, - "module": "_models", - "name": "handled_request_count", - "parsedDocstring": { - "text": "The number of requests that have been handled." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2219 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of requests that are pending and have not been handled yet." - } - ] - }, - "flags": {}, - "groups": [], - "id": 934, - "module": "_models", - "name": "pending_request_count", - "parsedDocstring": { - "text": "The number of requests that are pending and have not been handled yet." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2223 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Actor that created this request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 935, - "module": "_models", - "name": "act_id", - "parsedDocstring": { - "text": "The ID of the Actor that created this request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2227 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='actId')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Actor run that created this request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 936, - "module": "_models", - "name": "act_run_id", - "parsedDocstring": { - "text": "The ID of the Actor run that created this request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2231 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='actRunId')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the request queue has been accessed by multiple different clients." - } - ] - }, - "flags": {}, - "groups": [], - "id": 937, - "module": "_models", - "name": "had_multiple_clients", - "parsedDocstring": { - "text": "Whether the request queue has been accessed by multiple different clients." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2235 - } - ], - "type": { - "name": "bool", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A shortened request queue object for list responses." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 930, - 935, - 936, - 928, - 931, - 937, - 933, - 924, - 923, - 929, - 925, - 934, - 932, - 926, - 927 - ], - "title": "Properties" - } - ], - "id": 922, - "module": "_models", - "name": "RequestQueueShort", - "parsedDocstring": { - "text": "A shortened request queue object for list responses." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2176 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 939, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2245 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of delete operations performed on the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 940, - "module": "_models", - "name": "delete_count", - "parsedDocstring": { - "text": "The number of delete operations performed on the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2249 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='deleteCount', examples=[0])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of times requests from the head were read." - } - ] - }, - "flags": {}, - "groups": [], - "id": 941, - "module": "_models", - "name": "head_item_read_count", - "parsedDocstring": { - "text": "The number of times requests from the head were read." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2253 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='headItemReadCount', examples=[5])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total number of read operations performed on the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 942, - "module": "_models", - "name": "read_count", - "parsedDocstring": { - "text": "The total number of read operations performed on the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2257 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='readCount', examples=[100])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total storage size in bytes used by the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 943, - "module": "_models", - "name": "storage_bytes", - "parsedDocstring": { - "text": "The total storage size in bytes used by the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2261 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='storageBytes', examples=[1024])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total number of write operations performed on the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 944, - "module": "_models", - "name": "write_count", - "parsedDocstring": { - "text": "The total number of write operations performed on the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2265 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='writeCount', examples=[10])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statistics about request queue operations and storage." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 940, - 941, - 939, - 942, - 943, - 944 - ], - "title": "Properties" - } - ], - "id": 938, - "module": "_models", - "name": "RequestQueueStats", - "parsedDocstring": { - "text": "Statistics about request queue operations and storage." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2242 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 946, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2275 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the default request queue for this run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 947, - "module": "_models", - "name": "default", - "parsedDocstring": { - "text": "ID of the default request queue for this run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2279 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['FL35cSF7jrxr3BY39'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Aliased request queue IDs for this run." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 947, - 946 - ], - "title": "Properties" - } - ], - "id": 945, - "module": "_models", - "name": "RequestQueues", - "parsedDocstring": { - "text": "Aliased request queue IDs for this run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2272 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 949, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2289 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier assigned to the request." - } - ] - }, - "flags": {}, - "groups": [], - "id": 950, - "module": "_models", - "name": "request_id", - "parsedDocstring": { - "text": "A unique identifier assigned to the request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2293 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Indicates whether a request with the same unique key already existed in the request queue. If true, no new request was created." - } - ] - }, - "flags": {}, - "groups": [], - "id": 951, - "module": "_models", - "name": "was_already_present", - "parsedDocstring": { - "text": "Indicates whether a request with the same unique key already existed in the request queue. If true, no new request was created." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2297 - } - ], - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Indicates whether a request with the same unique key has already been processed by the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 952, - "module": "_models", - "name": "was_already_handled", - "parsedDocstring": { - "text": "Indicates whether a request with the same unique key has already been processed by the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2301 - } - ], - "type": { - "name": "bool", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Result of registering a request in the request queue, either by adding a new request or updating an existing one." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 949, - 950, - 952, - 951 - ], - "title": "Properties" - } - ], - "id": 948, - "module": "_models", - "name": "RequestRegistration", - "parsedDocstring": { - "text": "Result of registering a request in the request queue, either by adding a new request or updating an existing one." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2286 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 954, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2311 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 955, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2315 - } - ], - "type": { - "name": "Request", - "type": "reference", - "target": "876" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response containing a single request from the request queue." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 955, - 954 - ], - "title": "Properties" - } - ], - "id": 953, - "module": "_models", - "name": "RequestResponse", - "parsedDocstring": { - "text": "Response containing a single request from the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2308 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 957, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2322 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom user data attached to the request. Can contain arbitrary fields." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 957 - ], - "title": "Properties" - } - ], - "id": 956, - "module": "_models", - "name": "RequestUserData", - "parsedDocstring": { - "text": "Custom user data attached to the request. Can contain arbitrary fields." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2319 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 959, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2332 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique identifier of the Actor run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 960, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "Unique identifier of the Actor run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2336 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the Actor that was run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 961, - "module": "_models", - "name": "act_id", - "parsedDocstring": { - "text": "ID of the Actor that was run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2340 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the user who started the run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 962, - "module": "_models", - "name": "user_id", - "parsedDocstring": { - "text": "ID of the user who started the run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2344 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the Actor task, if the run was started from a task." - } - ] - }, - "flags": {}, - "groups": [], - "id": 963, - "module": "_models", - "name": "actor_task_id", - "parsedDocstring": { - "text": "ID of the Actor task, if the run was started from a task." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2348 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='actorTaskId', examples=['KJHSKHausidyaJKHs'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Time when the Actor run started." - } - ] - }, - "flags": {}, - "groups": [], - "id": 964, - "module": "_models", - "name": "started_at", - "parsedDocstring": { - "text": "Time when the Actor run started." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2352 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Time when the Actor run finished." - } - ] - }, - "flags": {}, - "groups": [], - "id": 965, - "module": "_models", - "name": "finished_at", - "parsedDocstring": { - "text": "Time when the Actor run finished." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2356 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Current status of the Actor run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 966, - "module": "_models", - "name": "status", - "parsedDocstring": { - "text": "Current status of the Actor run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2362 - } - ], - "type": { - "name": "ActorJobStatus", - "type": "reference", - "target": "1794" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Detailed message about the run status." - } - ] - }, - "flags": {}, - "groups": [], - "id": 967, - "module": "_models", - "name": "status_message", - "parsedDocstring": { - "text": "Detailed message about the run status." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2366 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='statusMessage', examples=['Actor is running'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the status message is terminal (final)." - } - ] - }, - "flags": {}, - "groups": [], - "id": 968, - "module": "_models", - "name": "is_status_message_terminal", - "parsedDocstring": { - "text": "Whether the status message is terminal (final)." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2370 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='isStatusMessageTerminal', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Metadata about the Actor run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 969, - "module": "_models", - "name": "meta", - "parsedDocstring": { - "text": "Metadata about the Actor run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2374 - } - ], - "type": { - "name": "RunMeta", - "type": "reference", - "target": "992" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pricing information for the Actor." - } - ] - }, - "flags": {}, - "groups": [], - "id": 970, - "module": "_models", - "name": "pricing_info", - "parsedDocstring": { - "text": "Pricing information for the Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2378 - } - ], - "type": { - "name": "Annotated[ PayPerEventActorPricingInfo | PricePerDatasetItemActorPricingInfo | FlatPricePerMonthActorPricingInfo | FreeActorPricingInfo | None, Field(alias='pricingInfo', discriminator='pricing_model', title='ActorRunPricingInfo'), ]", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "PayPerEventActorPricingInfo", - "target": "786" - }, - { - "type": "reference", - "name": "PricePerDatasetItemActorPricingInfo", - "target": "813" - } - ] - }, - { - "type": "reference", - "name": "FlatPricePerMonthActorPricingInfo", - "target": "570" - } - ] - }, - { - "type": "reference", - "name": "FreeActorPricingInfo", - "target": "575" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statistics of the Actor run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 971, - "module": "_models", - "name": "stats", - "parsedDocstring": { - "text": "Statistics of the Actor run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2389 - } - ], - "type": { - "name": "RunStats", - "type": "reference", - "target": "1025" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A map of charged event types to their counts. The keys are event type identifiers defined by the Actor's pricing model (pay-per-event), and the values are the number of times each event was charged during this run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 972, - "module": "_models", - "name": "charged_event_counts", - "parsedDocstring": { - "text": "A map of charged event types to their counts. The keys are event type identifiers defined by the Actor's pricing model (pay-per-event), and the values are the number of times each event was charged during this run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2393 - } - ], - "type": { - "name": "Annotated[ dict[str, int] | None, Field(alias='chargedEventCounts', examples=[{'actor-start': 1, 'page-crawled': 150, 'data-extracted': 75}]), ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "int" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration options for the Actor run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 973, - "module": "_models", - "name": "options", - "parsedDocstring": { - "text": "Configuration options for the Actor run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2400 - } - ], - "type": { - "name": "RunOptions", - "type": "reference", - "target": "999" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the Actor build used for this run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 974, - "module": "_models", - "name": "build_id", - "parsedDocstring": { - "text": "ID of the Actor build used for this run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2404 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Exit code of the Actor run process." - } - ] - }, - "flags": {}, - "groups": [], - "id": 975, - "module": "_models", - "name": "exit_code", - "parsedDocstring": { - "text": "Exit code of the Actor run process." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2408 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='exitCode', examples=[0])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "General access level for the Actor run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 976, - "module": "_models", - "name": "general_access", - "parsedDocstring": { - "text": "General access level for the Actor run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2412 - } - ], - "type": { - "name": "GeneralAccess", - "type": "reference", - "target": "1797" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the default key-value store for this run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 977, - "module": "_models", - "name": "default_key_value_store_id", - "parsedDocstring": { - "text": "ID of the default key-value store for this run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2416 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the default dataset for this run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 978, - "module": "_models", - "name": "default_dataset_id", - "parsedDocstring": { - "text": "ID of the default dataset for this run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2420 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the default request queue for this run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 979, - "module": "_models", - "name": "default_request_queue_id", - "parsedDocstring": { - "text": "ID of the default request queue for this run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2424 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A map of aliased storage IDs associated with this run, grouped by storage type." - } - ] - }, - "flags": {}, - "groups": [], - "id": 980, - "module": "_models", - "name": "storage_ids", - "parsedDocstring": { - "text": "A map of aliased storage IDs associated with this run, grouped by storage type." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2428 - } - ], - "type": { - "name": "Annotated[StorageIds | None, Field(alias='storageIds')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "StorageIds", - "target": "1167" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Build number of the Actor build used for this run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 981, - "module": "_models", - "name": "build_number", - "parsedDocstring": { - "text": "Build number of the Actor build used for this run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2432 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='buildNumber', examples=['0.0.36'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the container running the Actor." - } - ] - }, - "flags": {}, - "groups": [], - "id": 982, - "module": "_models", - "name": "container_url", - "parsedDocstring": { - "text": "URL of the container running the Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2436 - } - ], - "type": { - "name": "Annotated[ AnyUrl | None, Field(alias='containerUrl', examples=['https://g8kd8kbc5ge8.runs.apify.net']) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AnyUrl" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the container's HTTP server is ready to accept requests." - } - ] - }, - "flags": {}, - "groups": [], - "id": 983, - "module": "_models", - "name": "is_container_server_ready", - "parsedDocstring": { - "text": "Whether the container's HTTP server is ready to accept requests." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2442 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='isContainerServerReady', examples=[True])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the git branch used for the Actor build." - } - ] - }, - "flags": {}, - "groups": [], - "id": 984, - "module": "_models", - "name": "git_branch_name", - "parsedDocstring": { - "text": "Name of the git branch used for the Actor build." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2446 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='gitBranchName', examples=['master'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource usage statistics for the run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 985, - "module": "_models", - "name": "usage", - "parsedDocstring": { - "text": "Resource usage statistics for the run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2450 - } - ], - "type": { - "name": "RunUsage | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "RunUsage", - "target": "1047" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Total cost in USD for this run. Represents what you actually pay. For run owners: includes platform usage (compute units) and/or event costs depending on the Actor's pricing model. For run non-owners: only available for Pay-Per-Event Actors (event costs only). Requires authentication token to access." - } - ] - }, - "flags": {}, - "groups": [], - "id": 986, - "module": "_models", - "name": "usage_total_usd", - "parsedDocstring": { - "text": "Total cost in USD for this run. Represents what you actually pay. For run owners: includes platform usage (compute units) and/or event costs depending on the Actor's pricing model. For run non-owners: only available for Pay-Per-Event Actors (event costs only). Requires authentication token to access." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2454 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='usageTotalUsd', examples=[0.2654])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Platform usage costs breakdown in USD. Only present if you own the run AND are paying for platform usage (Pay-Per-Usage, Rental, or Pay-Per-Event with usage costs like standby Actors). Not available for standard Pay-Per-Event Actors. Requires authentication token to access." - } - ] - }, - "flags": {}, - "groups": [], - "id": 987, - "module": "_models", - "name": "usage_usd", - "parsedDocstring": { - "text": "Platform usage costs breakdown in USD. Only present if you own the run AND are paying for platform usage (Pay-Per-Usage, Rental, or Pay-Per-Event with usage costs like standby Actors). Not available for standard Pay-Per-Event Actors. Requires authentication token to access." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2458 - } - ], - "type": { - "name": "Annotated[RunUsageUsd | None, Field(alias='usageUsd')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "RunUsageUsd", - "target": "1061" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of metamorph events that occurred during the run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 988, - "module": "_models", - "name": "metamorphs", - "parsedDocstring": { - "text": "List of metamorph events that occurred during the run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2462 - } - ], - "type": { - "name": "list[Metamorph] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "Metamorph", - "target": "730" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Represents an Actor run and its associated data." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 961, - 963, - 974, - 981, - 972, - 982, - 978, - 977, - 979, - 975, - 965, - 976, - 984, - 960, - 983, - 968, - 969, - 988, - 959, - 973, - 970, - 964, - 971, - 966, - 967, - 980, - 985, - 986, - 987, - 962 - ], - "title": "Properties" - } - ], - "id": 958, - "module": "_models", - "name": "Run", - "parsedDocstring": { - "text": "Represents an Actor run and its associated data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2329 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 990, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2470 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "ErrorDetail.model_config", - "target": 552, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Machine-processable error type identifier." - } - ] - }, - "flags": {}, - "groups": [], - "id": 991, - "module": "_models", - "name": "type", - "parsedDocstring": { - "text": "Machine-processable error type identifier." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2474 - } - ], - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "run-failed" - } - ] - }, - "overwrites": { - "name": "ErrorDetail.type", - "target": 553, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable error message describing what went wrong." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4047, - "module": "_models", - "name": "message", - "parsedDocstring": { - "text": "Human-readable error message describing what went wrong." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1007 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ErrorDetail.message", - "target": 554, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4047, - 990, - 991 - ], - "title": "Properties" - } - ], - "id": 989, - "module": "_models", - "name": "RunFailedErrorDetail", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2469 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ErrorDetail", - "target": "551", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 993, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2482 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 994, - "module": "_models", - "name": "origin", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2486 - } - ], - "type": { - "name": "RunOrigin", - "type": "reference", - "target": "1799" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "IP address of the client that started the run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 995, - "module": "_models", - "name": "client_ip", - "parsedDocstring": { - "text": "IP address of the client that started the run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2487 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='clientIp')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "User agent of the client that started the run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 996, - "module": "_models", - "name": "user_agent", - "parsedDocstring": { - "text": "User agent of the client that started the run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2491 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='userAgent')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the schedule that triggered the run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 997, - "module": "_models", - "name": "schedule_id", - "parsedDocstring": { - "text": "ID of the schedule that triggered the run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2495 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='scheduleId')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Time when the run was scheduled." - } - ] - }, - "flags": {}, - "groups": [], - "id": 998, - "module": "_models", - "name": "scheduled_at", - "parsedDocstring": { - "text": "Time when the run was scheduled." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2499 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='scheduledAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 995, - 993, - 994, - 997, - 998, - 996 - ], - "title": "Properties" - } - ], - "id": 992, - "module": "_models", - "name": "RunMeta", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2481 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1000, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2507 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1001, - "module": "_models", - "name": "build", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2511 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1002, - "module": "_models", - "name": "timeout_secs", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2512 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1003, - "module": "_models", - "name": "memory_mbytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2513 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1004, - "module": "_models", - "name": "disk_mbytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2514 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1005, - "module": "_models", - "name": "max_items", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2515 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='maxItems', examples=[1000], ge=1)]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1006, - "module": "_models", - "name": "max_total_charge_usd", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2516 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='maxTotalChargeUsd', examples=[5], ge=0.0)]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1001, - 1004, - 1005, - 1006, - 1003, - 1000, - 1002 - ], - "title": "Properties" - } - ], - "id": 999, - "module": "_models", - "name": "RunOptions", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2506 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1008, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2521 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1009, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2525 - } - ], - "type": { - "name": "Run", - "type": "reference", - "target": "958" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1009, - 1008 - ], - "title": "Properties" - } - ], - "id": 1007, - "module": "_models", - "name": "RunResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2520 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1011, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2530 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1012, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2534 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1013, - "module": "_models", - "name": "act_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2535 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1014, - "module": "_models", - "name": "actor_task_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2536 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='actorTaskId', examples=['KJHSKHausidyaJKHs'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1015, - "module": "_models", - "name": "status", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2537 - } - ], - "type": { - "name": "ActorJobStatus", - "type": "reference", - "target": "1794" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1016, - "module": "_models", - "name": "started_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2538 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1017, - "module": "_models", - "name": "finished_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2539 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1018, - "module": "_models", - "name": "build_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2542 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1019, - "module": "_models", - "name": "build_number", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2543 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='buildNumber', examples=['0.0.2'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1020, - "module": "_models", - "name": "meta", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2544 - } - ], - "type": { - "name": "RunMeta", - "type": "reference", - "target": "992" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1021, - "module": "_models", - "name": "usage_total_usd", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2545 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1022, - "module": "_models", - "name": "default_key_value_store_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2546 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1023, - "module": "_models", - "name": "default_dataset_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2547 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1024, - "module": "_models", - "name": "default_request_queue_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2548 - } - ], - "type": { - "name": "str", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1013, - 1014, - 1018, - 1019, - 1023, - 1022, - 1024, - 1017, - 1012, - 1020, - 1011, - 1016, - 1015, - 1021 - ], - "title": "Properties" - } - ], - "id": 1010, - "module": "_models", - "name": "RunShort", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2529 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1026, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2553 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1027, - "module": "_models", - "name": "input_body_len", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2557 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='inputBodyLen', examples=[240], ge=0)]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1028, - "module": "_models", - "name": "migration_count", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2558 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='migrationCount', examples=[0], ge=0)]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1029, - "module": "_models", - "name": "reboot_count", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2559 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='rebootCount', examples=[0], ge=0)]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1030, - "module": "_models", - "name": "restart_count", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2560 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1031, - "module": "_models", - "name": "resurrect_count", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2561 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1032, - "module": "_models", - "name": "mem_avg_bytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2562 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='memAvgBytes', examples=[267874071.9])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1033, - "module": "_models", - "name": "mem_max_bytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2563 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='memMaxBytes', examples=[404713472], ge=0)]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1034, - "module": "_models", - "name": "mem_current_bytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2564 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='memCurrentBytes', examples=[0], ge=0)]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1035, - "module": "_models", - "name": "cpu_avg_usage", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2565 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='cpuAvgUsage', examples=[33.7532101107538])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1036, - "module": "_models", - "name": "cpu_max_usage", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2566 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='cpuMaxUsage', examples=[169.650735534941])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1037, - "module": "_models", - "name": "cpu_current_usage", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2567 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='cpuCurrentUsage', examples=[0])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1038, - "module": "_models", - "name": "net_rx_bytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2568 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='netRxBytes', examples=[103508042], ge=0)]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1039, - "module": "_models", - "name": "net_tx_bytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2569 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='netTxBytes', examples=[4854600], ge=0)]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1040, - "module": "_models", - "name": "duration_millis", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2570 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='durationMillis', examples=[248472], ge=0)]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1041, - "module": "_models", - "name": "run_time_secs", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2571 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='runTimeSecs', examples=[248.472], ge=0.0)]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1042, - "module": "_models", - "name": "metamorph", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2572 - } - ], - "type": { - "name": "Annotated[int | None, Field(examples=[0], ge=0)]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1043, - "module": "_models", - "name": "compute_units", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2573 - } - ], - "type": { - "name": "float", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1043, - 1035, - 1037, - 1036, - 1040, - 1027, - 1032, - 1034, - 1033, - 1042, - 1028, - 1026, - 1038, - 1039, - 1029, - 1030, - 1031, - 1041 - ], - "title": "Properties" - } - ], - "id": 1025, - "module": "_models", - "name": "RunStats", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2552 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1045, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2578 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "ErrorDetail.model_config", - "target": 552, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Machine-processable error type identifier." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1046, - "module": "_models", - "name": "type", - "parsedDocstring": { - "text": "Machine-processable error type identifier." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2582 - } - ], - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "run-timeout-exceeded" - } - ] - }, - "overwrites": { - "name": "ErrorDetail.type", - "target": 553, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable error message describing what went wrong." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4048, - "module": "_models", - "name": "message", - "parsedDocstring": { - "text": "Human-readable error message describing what went wrong." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1007 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ErrorDetail.message", - "target": 554, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4048, - 1045, - 1046 - ], - "title": "Properties" - } - ], - "id": 1044, - "module": "_models", - "name": "RunTimeoutExceededErrorDetail", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2577 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ErrorDetail", - "target": "551", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1048, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2590 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1049, - "module": "_models", - "name": "actor_compute_units", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2594 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='ACTOR_COMPUTE_UNITS', examples=[3])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1050, - "module": "_models", - "name": "dataset_reads", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2595 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='DATASET_READS', examples=[4])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1051, - "module": "_models", - "name": "dataset_writes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2596 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='DATASET_WRITES', examples=[4])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1052, - "module": "_models", - "name": "key_value_store_reads", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2597 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='KEY_VALUE_STORE_READS', examples=[5])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1053, - "module": "_models", - "name": "key_value_store_writes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2598 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='KEY_VALUE_STORE_WRITES', examples=[3])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1054, - "module": "_models", - "name": "key_value_store_lists", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2599 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='KEY_VALUE_STORE_LISTS', examples=[5])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1055, - "module": "_models", - "name": "request_queue_reads", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2600 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='REQUEST_QUEUE_READS', examples=[2])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1056, - "module": "_models", - "name": "request_queue_writes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2601 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='REQUEST_QUEUE_WRITES', examples=[1])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1057, - "module": "_models", - "name": "data_transfer_internal_gbytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2602 - } - ], - "type": { - "name": "Annotated[ float | None, Field(alias='DATA_TRANSFER_INTERNAL_GBYTES', examples=[1]) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1058, - "module": "_models", - "name": "data_transfer_external_gbytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2605 - } - ], - "type": { - "name": "Annotated[ float | None, Field(alias='DATA_TRANSFER_EXTERNAL_GBYTES', examples=[3]) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1059, - "module": "_models", - "name": "proxy_residential_transfer_gbytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2608 - } - ], - "type": { - "name": "Annotated[ float | None, Field(alias='PROXY_RESIDENTIAL_TRANSFER_GBYTES', examples=[34]) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1060, - "module": "_models", - "name": "proxy_serps", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2611 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='PROXY_SERPS', examples=[3])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1049, - 1058, - 1057, - 1050, - 1051, - 1054, - 1052, - 1053, - 1048, - 1059, - 1060, - 1055, - 1056 - ], - "title": "Properties" - } - ], - "id": 1047, - "module": "_models", - "name": "RunUsage", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2589 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1062, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2618 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1063, - "module": "_models", - "name": "actor_compute_units", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2622 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='ACTOR_COMPUTE_UNITS', examples=[0.0003])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1064, - "module": "_models", - "name": "dataset_reads", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2623 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='DATASET_READS', examples=[0.0001])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1065, - "module": "_models", - "name": "dataset_writes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2624 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='DATASET_WRITES', examples=[0.0001])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1066, - "module": "_models", - "name": "key_value_store_reads", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2625 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='KEY_VALUE_STORE_READS', examples=[0.0001])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1067, - "module": "_models", - "name": "key_value_store_writes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2626 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='KEY_VALUE_STORE_WRITES', examples=[5e-05])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1068, - "module": "_models", - "name": "key_value_store_lists", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2627 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='KEY_VALUE_STORE_LISTS', examples=[0.0001])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1069, - "module": "_models", - "name": "request_queue_reads", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2628 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='REQUEST_QUEUE_READS', examples=[0.0001])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1070, - "module": "_models", - "name": "request_queue_writes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2629 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='REQUEST_QUEUE_WRITES', examples=[0.0001])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1071, - "module": "_models", - "name": "data_transfer_internal_gbytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2630 - } - ], - "type": { - "name": "Annotated[ float | None, Field(alias='DATA_TRANSFER_INTERNAL_GBYTES', examples=[0.001]) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1072, - "module": "_models", - "name": "data_transfer_external_gbytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2633 - } - ], - "type": { - "name": "Annotated[ float | None, Field(alias='DATA_TRANSFER_EXTERNAL_GBYTES', examples=[0.003]) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1073, - "module": "_models", - "name": "proxy_residential_transfer_gbytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2636 - } - ], - "type": { - "name": "Annotated[ float | None, Field(alias='PROXY_RESIDENTIAL_TRANSFER_GBYTES', examples=[0.034]) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1074, - "module": "_models", - "name": "proxy_serps", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2639 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='PROXY_SERPS', examples=[0.003])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource usage costs in USD. All values are monetary amounts in US dollars." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1063, - 1072, - 1071, - 1064, - 1065, - 1068, - 1066, - 1067, - 1062, - 1073, - 1074, - 1069, - 1070 - ], - "title": "Properties" - } - ], - "id": 1061, - "module": "_models", - "name": "RunUsageUsd", - "parsedDocstring": { - "text": "Resource usage costs in USD. All values are monetary amounts in US dollars." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2615 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1076, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2644 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1077, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2648 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1078, - "module": "_models", - "name": "type", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2649 - } - ], - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "RUN_ACTOR" - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1079, - "module": "_models", - "name": "actor_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2650 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1080, - "module": "_models", - "name": "run_input", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2651 - } - ], - "type": { - "name": "Annotated[ScheduleActionRunInput | None, Field(alias='runInput')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ScheduleActionRunInput", - "target": "1088" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1081, - "module": "_models", - "name": "run_options", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2652 - } - ], - "type": { - "name": "Annotated[TaskOptions | None, Field(alias='runOptions')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "TaskOptions", - "target": "1215" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1079, - 1077, - 1076, - 1080, - 1081, - 1078 - ], - "title": "Properties" - } - ], - "id": 1075, - "module": "_models", - "name": "ScheduleActionRunActor", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2643 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1083, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2657 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1084, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2661 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1085, - "module": "_models", - "name": "type", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2662 - } - ], - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "RUN_ACTOR_TASK" - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1086, - "module": "_models", - "name": "actor_task_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2663 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1087, - "module": "_models", - "name": "input", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2664 - } - ], - "type": { - "name": "dict[str, Any] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1086, - 1084, - 1087, - 1083, - 1085 - ], - "title": "Properties" - } - ], - "id": 1082, - "module": "_models", - "name": "ScheduleActionRunActorTask", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2656 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1089, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2669 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1090, - "module": "_models", - "name": "body", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2673 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['{\\\\n \"foo\": \"actor\"\\\\n}'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1091, - "module": "_models", - "name": "content_type", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2674 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='contentType', examples=['application/json; charset=utf-8'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1090, - 1091, - 1089 - ], - "title": "Properties" - } - ], - "id": 1088, - "module": "_models", - "name": "ScheduleActionRunInput", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2668 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1093, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2679 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1094, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2683 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1095, - "module": "_models", - "name": "type", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2684 - } - ], - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "RUN_ACTOR" - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1096, - "module": "_models", - "name": "actor_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2685 - } - ], - "type": { - "name": "str", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1096, - 1094, - 1093, - 1095 - ], - "title": "Properties" - } - ], - "id": 1092, - "module": "_models", - "name": "ScheduleActionShortRunActor", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2678 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1098, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2690 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1099, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2694 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1100, - "module": "_models", - "name": "type", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2695 - } - ], - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "RUN_ACTOR_TASK" - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1101, - "module": "_models", - "name": "actor_task_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2696 - } - ], - "type": { - "name": "str", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1101, - 1099, - 1098, - 1100 - ], - "title": "Properties" - } - ], - "id": 1097, - "module": "_models", - "name": "ScheduleActionShortRunActorTask", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2689 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1103, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2701 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1104, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2705 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1105, - "module": "_models", - "name": "user_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2706 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1106, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2707 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1107, - "module": "_models", - "name": "cron_expression", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2708 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1108, - "module": "_models", - "name": "timezone", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2709 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1109, - "module": "_models", - "name": "is_enabled", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2710 - } - ], - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1110, - "module": "_models", - "name": "is_exclusive", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2711 - } - ], - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1111, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2712 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1112, - "module": "_models", - "name": "modified_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2713 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1113, - "module": "_models", - "name": "next_run_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2714 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='nextRunAt', examples=['2019-04-12T07:34:10.202Z'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1114, - "module": "_models", - "name": "last_run_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2715 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='lastRunAt', examples=['2019-04-12T07:33:10.202Z'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1111, - 1107, - 1104, - 1109, - 1110, - 1114, - 1103, - 1112, - 1106, - 1113, - 1108, - 1105 - ], - "title": "Properties" - } - ], - "id": 1102, - "module": "_models", - "name": "ScheduleBase", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2700 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "Schedule", - "target": "1115", - "type": "reference" - }, - { - "name": "ScheduleShort", - "target": "1152", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1116, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2720 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "ScheduleBase.model_config", - "target": 1103, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1117, - "module": "_models", - "name": "description", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2724 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['Schedule of actor ...'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1118, - "module": "_models", - "name": "title", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2725 - } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1119, - "module": "_models", - "name": "actions", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2726 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "ScheduleActionRunActor", - "target": "1075" - }, - { - "type": "reference", - "name": "ScheduleActionRunActorTask", - "target": "1082" - } - ] - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4025, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2705 - } - ], - "type": { - "name": "str", - "type": "reference" - }, - "inheritedFrom": { - "name": "ScheduleBase.id", - "target": 1104, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4026, - "module": "_models", - "name": "user_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2706 - } - ], - "type": { - "name": "str", - "type": "reference" - }, - "inheritedFrom": { - "name": "ScheduleBase.user_id", - "target": 1105, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4027, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2707 - } - ], - "type": { - "name": "str", - "type": "reference" - }, - "inheritedFrom": { - "name": "ScheduleBase.name", - "target": 1106, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4028, - "module": "_models", - "name": "cron_expression", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2708 - } - ], - "type": { - "name": "str", - "type": "reference" - }, - "inheritedFrom": { - "name": "ScheduleBase.cron_expression", - "target": 1107, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4029, - "module": "_models", - "name": "timezone", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2709 - } - ], - "type": { - "name": "str", - "type": "reference" - }, - "inheritedFrom": { - "name": "ScheduleBase.timezone", - "target": 1108, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4030, - "module": "_models", - "name": "is_enabled", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2710 - } - ], - "type": { - "name": "bool", - "type": "reference" - }, - "inheritedFrom": { - "name": "ScheduleBase.is_enabled", - "target": 1109, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4031, - "module": "_models", - "name": "is_exclusive", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2711 - } - ], - "type": { - "name": "bool", - "type": "reference" - }, - "inheritedFrom": { - "name": "ScheduleBase.is_exclusive", - "target": 1110, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4032, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2712 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - }, - "inheritedFrom": { - "name": "ScheduleBase.created_at", - "target": 1111, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4033, - "module": "_models", - "name": "modified_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2713 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - }, - "inheritedFrom": { - "name": "ScheduleBase.modified_at", - "target": 1112, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4034, - "module": "_models", - "name": "next_run_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2714 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='nextRunAt', examples=['2019-04-12T07:34:10.202Z'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "ScheduleBase.next_run_at", - "target": 1113, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4035, - "module": "_models", - "name": "last_run_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2715 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='lastRunAt', examples=['2019-04-12T07:33:10.202Z'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "ScheduleBase.last_run_at", - "target": 1114, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1119, - 4032, - 4028, - 1117, - 4025, - 4030, - 4031, - 4035, - 1116, - 4033, - 4027, - 4034, - 4029, - 1118, - 4026 - ], - "title": "Properties" - } - ], - "id": 1115, - "module": "_models", - "name": "Schedule", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2719 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ScheduleBase", - "target": "1102", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1121, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2731 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1122, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2735 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['my-schedule'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1123, - "module": "_models", - "name": "is_enabled", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2736 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='isEnabled', examples=[True])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1124, - "module": "_models", - "name": "is_exclusive", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2737 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='isExclusive', examples=[True])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1125, - "module": "_models", - "name": "cron_expression", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2738 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='cronExpression', examples=['* * * * *'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1126, - "module": "_models", - "name": "timezone", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2739 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['UTC'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1127, - "module": "_models", - "name": "description", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2740 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['Schedule of actor ...'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1128, - "module": "_models", - "name": "title", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2741 - } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1129, - "module": "_models", - "name": "actions", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2742 - } - ], - "type": { - "name": "( list[Annotated[ScheduleCreateActionRunActor | ScheduleCreateActionRunActorTask, Field(discriminator='type')]] | None )", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "ScheduleCreateActionRunActor", - "target": "1130" - }, - { - "type": "reference", - "name": "ScheduleCreateActionRunActorTask", - "target": "1136" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1129, - 1125, - 1127, - 1123, - 1124, - 1121, - 1122, - 1126, - 1128 - ], - "title": "Properties" - } - ], - "id": 1120, - "module": "_models", - "name": "ScheduleCreate", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2730 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1131, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2750 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1132, - "module": "_models", - "name": "type", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2754 - } - ], - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "RUN_ACTOR" - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1133, - "module": "_models", - "name": "actor_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2755 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1134, - "module": "_models", - "name": "run_input", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2756 - } - ], - "type": { - "name": "Annotated[ScheduleActionRunInput | None, Field(alias='runInput')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ScheduleActionRunInput", - "target": "1088" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1135, - "module": "_models", - "name": "run_options", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2757 - } - ], - "type": { - "name": "Annotated[TaskOptions | None, Field(alias='runOptions')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "TaskOptions", - "target": "1215" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1133, - 1131, - 1134, - 1135, - 1132 - ], - "title": "Properties" - } - ], - "id": 1130, - "module": "_models", - "name": "ScheduleCreateActionRunActor", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2749 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1137, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2762 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1138, - "module": "_models", - "name": "type", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2766 - } - ], - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "RUN_ACTOR_TASK" - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1139, - "module": "_models", - "name": "actor_task_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2767 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1140, - "module": "_models", - "name": "input", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2768 - } - ], - "type": { - "name": "dict[str, Any] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1139, - 1140, - 1137, - 1138 - ], - "title": "Properties" - } - ], - "id": 1136, - "module": "_models", - "name": "ScheduleCreateActionRunActorTask", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2761 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1142, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2773 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1143, - "module": "_models", - "name": "message", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2777 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1144, - "module": "_models", - "name": "level", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2778 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1145, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2779 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1145, - 1144, - 1143, - 1142 - ], - "title": "Properties" - } - ], - "id": 1141, - "module": "_models", - "name": "ScheduleInvoked", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2772 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1147, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2784 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1148, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2788 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ScheduleInvoked", - "target": "1141" - } - ], - "target": "2199" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1148, - 1147 - ], - "title": "Properties" - } - ], - "id": 1146, - "module": "_models", - "name": "ScheduleLogResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2783 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1150, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2793 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1151, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2797 - } - ], - "type": { - "name": "Schedule", - "type": "reference", - "target": "1115" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1151, - 1150 - ], - "title": "Properties" - } - ], - "id": 1149, - "module": "_models", - "name": "ScheduleResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2792 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1153, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2802 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "ScheduleBase.model_config", - "target": 1103, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1154, - "module": "_models", - "name": "actions", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2806 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "ScheduleActionShortRunActor", - "target": "1092" - }, - { - "type": "reference", - "name": "ScheduleActionShortRunActorTask", - "target": "1097" - } - ] - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4036, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2705 - } - ], - "type": { - "name": "str", - "type": "reference" - }, - "inheritedFrom": { - "name": "ScheduleBase.id", - "target": 1104, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4037, - "module": "_models", - "name": "user_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2706 - } - ], - "type": { - "name": "str", - "type": "reference" - }, - "inheritedFrom": { - "name": "ScheduleBase.user_id", - "target": 1105, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4038, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2707 - } - ], - "type": { - "name": "str", - "type": "reference" - }, - "inheritedFrom": { - "name": "ScheduleBase.name", - "target": 1106, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4039, - "module": "_models", - "name": "cron_expression", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2708 - } - ], - "type": { - "name": "str", - "type": "reference" - }, - "inheritedFrom": { - "name": "ScheduleBase.cron_expression", - "target": 1107, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4040, - "module": "_models", - "name": "timezone", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2709 - } - ], - "type": { - "name": "str", - "type": "reference" - }, - "inheritedFrom": { - "name": "ScheduleBase.timezone", - "target": 1108, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4041, - "module": "_models", - "name": "is_enabled", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2710 - } - ], - "type": { - "name": "bool", - "type": "reference" - }, - "inheritedFrom": { - "name": "ScheduleBase.is_enabled", - "target": 1109, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4042, - "module": "_models", - "name": "is_exclusive", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2711 - } - ], - "type": { - "name": "bool", - "type": "reference" - }, - "inheritedFrom": { - "name": "ScheduleBase.is_exclusive", - "target": 1110, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4043, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2712 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - }, - "inheritedFrom": { - "name": "ScheduleBase.created_at", - "target": 1111, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4044, - "module": "_models", - "name": "modified_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2713 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - }, - "inheritedFrom": { - "name": "ScheduleBase.modified_at", - "target": 1112, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4045, - "module": "_models", - "name": "next_run_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2714 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='nextRunAt', examples=['2019-04-12T07:34:10.202Z'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "ScheduleBase.next_run_at", - "target": 1113, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4046, - "module": "_models", - "name": "last_run_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2715 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='lastRunAt', examples=['2019-04-12T07:33:10.202Z'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "ScheduleBase.last_run_at", - "target": 1114, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1154, - 4043, - 4039, - 4036, - 4041, - 4042, - 4046, - 1153, - 4044, - 4038, - 4045, - 4040, - 4037 - ], - "title": "Properties" - } - ], - "id": 1152, - "module": "_models", - "name": "ScheduleShort", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2801 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ScheduleBase", - "target": "1102", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1156, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2811 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of invalid items in the received array of items." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1157, - "module": "_models", - "name": "invalid_items", - "parsedDocstring": { - "text": "A list of invalid items in the received array of items." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2815 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "InvalidItem", - "target": "591" - } - ], - "target": "2199" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1157, - 1156 - ], - "title": "Properties" - } - ], - "id": 1155, - "module": "_models", - "name": "SchemaValidationErrorData", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2810 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1159, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2823 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1160, - "module": "_models", - "name": "format", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2827 - } - ], - "type": { - "name": "SourceCodeFileFormat | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "SourceCodeFileFormat", - "target": "1800" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1161, - "module": "_models", - "name": "content", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2828 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=[\"console.log('This is the main.js file');\"])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1162, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2829 - } - ], - "type": { - "name": "str", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1161, - 1160, - 1159, - 1162 - ], - "title": "Properties" - } - ], - "id": 1158, - "module": "_models", - "name": "SourceCodeFile", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2822 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1164, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2839 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The folder path relative to the Actor's root directory." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1165, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "The folder path relative to the Actor's root directory." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2843 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Always `true` for folders. Used to distinguish folders from files." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1166, - "module": "_models", - "name": "folder", - "parsedDocstring": { - "text": "Always `true` for folders. Used to distinguish folders from files." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2847 - } - ], - "type": { - "name": "bool", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Represents a folder in the Actor's source code structure. Distinguished from\nSourceCodeFile by the presence of the `folder` property set to `true`." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1166, - 1164, - 1165 - ], - "title": "Properties" - } - ], - "id": 1163, - "module": "_models", - "name": "SourceCodeFolder", - "parsedDocstring": { - "text": "Represents a folder in the Actor's source code structure. Distinguished from\nSourceCodeFile by the presence of the `folder` property set to `true`." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2833 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1168, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2857 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Aliased dataset IDs for this run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1169, - "module": "_models", - "name": "datasets", - "parsedDocstring": { - "text": "Aliased dataset IDs for this run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2861 - } - ], - "type": { - "name": "Datasets | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Datasets", - "target": "488" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Aliased key-value store IDs for this run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1170, - "module": "_models", - "name": "key_value_stores", - "parsedDocstring": { - "text": "Aliased key-value store IDs for this run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2865 - } - ], - "type": { - "name": "Annotated[KeyValueStores | None, Field(alias='keyValueStores')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "KeyValueStores", - "target": "626" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Aliased request queue IDs for this run." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1171, - "module": "_models", - "name": "request_queues", - "parsedDocstring": { - "text": "Aliased request queue IDs for this run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2869 - } - ], - "type": { - "name": "Annotated[RequestQueues | None, Field(alias='requestQueues')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestQueues", - "target": "945" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A map of aliased storage IDs associated with this run, grouped by storage type." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1169, - 1170, - 1168, - 1171 - ], - "title": "Properties" - } - ], - "id": 1167, - "module": "_models", - "name": "StorageIds", - "parsedDocstring": { - "text": "A map of aliased storage IDs associated with this run, grouped by storage type." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2854 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1173, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2877 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Defines the schema of items in your dataset, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema)" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1174, - "module": "_models", - "name": "dataset", - "parsedDocstring": { - "text": "Defines the schema of items in your dataset, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema)" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2881 - } - ], - "type": { - "name": "dict[str, Any] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1174, - 1173 - ], - "title": "Properties" - } - ], - "id": 1172, - "module": "_models", - "name": "Storages", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2876 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1176, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2889 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1177, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2893 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1178, - "module": "_models", - "name": "title", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2894 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1179, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2895 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1180, - "module": "_models", - "name": "username", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2896 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1181, - "module": "_models", - "name": "user_full_name", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2897 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1182, - "module": "_models", - "name": "description", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2898 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1183, - "module": "_models", - "name": "categories", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2899 - } - ], - "type": { - "name": "Annotated[list[str] | None, Field(examples=[['MARKETING', 'LEAD_GENERATION']])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1184, - "module": "_models", - "name": "notice", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2900 - } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1185, - "module": "_models", - "name": "picture_url", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2901 - } - ], - "type": { - "name": "Annotated[AnyUrl | None, Field(alias='pictureUrl', examples=['https://...'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AnyUrl" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1186, - "module": "_models", - "name": "user_picture_url", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2902 - } - ], - "type": { - "name": "Annotated[AnyUrl | None, Field(alias='userPictureUrl', examples=['https://...'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AnyUrl" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1187, - "module": "_models", - "name": "url", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2903 - } - ], - "type": { - "name": "Annotated[AnyUrl | None, Field(examples=['https://...'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AnyUrl" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1188, - "module": "_models", - "name": "stats", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2904 - } - ], - "type": { - "name": "ActorStats", - "type": "reference", - "target": "265" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1189, - "module": "_models", - "name": "current_pricing_info", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2905 - } - ], - "type": { - "name": "CurrentPricingInfo", - "type": "reference", - "target": "424" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Actor is whitelisted for agentic payment processing." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1190, - "module": "_models", - "name": "is_white_listed_for_agentic_payment", - "parsedDocstring": { - "text": "Whether the Actor is whitelisted for agentic payment processing." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2906 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='isWhiteListedForAgenticPayment')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A brief, LLM-generated readme summary" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1191, - "module": "_models", - "name": "readme_summary", - "parsedDocstring": { - "text": "A brief, LLM-generated readme summary" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2910 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='readmeSummary')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1183, - 1189, - 1182, - 1177, - 1190, - 1176, - 1179, - 1184, - 1185, - 1191, - 1188, - 1178, - 1187, - 1181, - 1186, - 1180 - ], - "title": "Properties" - } - ], - "id": 1175, - "module": "_models", - "name": "StoreListActor", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2888 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1193, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2920 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the build associated with this tag." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1194, - "module": "_models", - "name": "build_id", - "parsedDocstring": { - "text": "The ID of the build associated with this tag." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2924 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='buildId', examples=['z2EryhbfhgSyqj6Hn'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The build number/version string." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1195, - "module": "_models", - "name": "build_number", - "parsedDocstring": { - "text": "The build number/version string." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2928 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='buildNumber', examples=['0.0.2'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timestamp when the build finished." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1196, - "module": "_models", - "name": "finished_at", - "parsedDocstring": { - "text": "The timestamp when the build finished." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2932 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-06-10T11:15:49.286Z'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Information about a tagged build." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1194, - 1195, - 1196, - 1193 - ], - "title": "Properties" - } - ], - "id": 1192, - "module": "_models", - "name": "TaggedBuildInfo", - "parsedDocstring": { - "text": "Information about a tagged build." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2917 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1198, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2942 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1199, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2946 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1200, - "module": "_models", - "name": "user_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2947 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1201, - "module": "_models", - "name": "act_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2948 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1202, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2949 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1203, - "module": "_models", - "name": "username", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2950 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['janedoe'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1204, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2951 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1205, - "module": "_models", - "name": "modified_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2952 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1206, - "module": "_models", - "name": "removed_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2953 - } - ], - "type": { - "name": "Annotated[AwareDatetime | None, Field(alias='removedAt')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AwareDatetime" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1207, - "module": "_models", - "name": "stats", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2954 - } - ], - "type": { - "name": "TaskStats | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "TaskStats", - "target": "1238" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1208, - "module": "_models", - "name": "options", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2955 - } - ], - "type": { - "name": "TaskOptions | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "TaskOptions", - "target": "1215" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1209, - "module": "_models", - "name": "input", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2956 - } - ], - "type": { - "name": "TaskInput | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "TaskInput", - "target": "1213" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1210, - "module": "_models", - "name": "title", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2957 - } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1211, - "module": "_models", - "name": "actor_standby", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2958 - } - ], - "type": { - "name": "Annotated[ActorStandby | None, Field(alias='actorStandby')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorStandby", - "target": "255" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1212, - "module": "_models", - "name": "standby_url", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2959 - } - ], - "type": { - "name": "Annotated[AnyUrl | None, Field(alias='standbyUrl')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AnyUrl" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1201, - 1211, - 1204, - 1199, - 1209, - 1198, - 1205, - 1202, - 1208, - 1206, - 1212, - 1207, - 1210, - 1200, - 1203 - ], - "title": "Properties" - } - ], - "id": 1197, - "module": "_models", - "name": "Task", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2941 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1214, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2969 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The input configuration for the Actor task. This is a user-defined JSON object\nthat will be passed to the Actor when the task is run." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1214 - ], - "title": "Properties" - } - ], - "id": 1213, - "module": "_models", - "name": "TaskInput", - "parsedDocstring": { - "text": "The input configuration for the Actor task. This is a user-defined JSON object\nthat will be passed to the Actor when the task is run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2963 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1216, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2977 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1217, - "module": "_models", - "name": "build", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2981 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['latest'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1218, - "module": "_models", - "name": "timeout_secs", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2982 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='timeoutSecs', examples=[300])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1219, - "module": "_models", - "name": "memory_mbytes", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2983 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='memoryMbytes', examples=[1024])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1220, - "module": "_models", - "name": "max_items", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2984 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='maxItems', examples=[1000])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1221, - "module": "_models", - "name": "max_total_charge_usd", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2985 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='maxTotalChargeUsd', examples=[5])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1222, - "module": "_models", - "name": "restart_on_error", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2986 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='restartOnError', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1217, - 1220, - 1221, - 1219, - 1216, - 1222, - 1218 - ], - "title": "Properties" - } - ], - "id": 1215, - "module": "_models", - "name": "TaskOptions", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2976 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1224, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2993 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1225, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2997 - } - ], - "type": { - "name": "Task", - "type": "reference", - "target": "1197" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response containing Actor task data." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1225, - 1224 - ], - "title": "Properties" - } - ], - "id": 1223, - "module": "_models", - "name": "TaskResponse", - "parsedDocstring": { - "text": "Response containing Actor task data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 2990 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1227, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3002 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1228, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3006 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1229, - "module": "_models", - "name": "user_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3007 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1230, - "module": "_models", - "name": "act_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3008 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1231, - "module": "_models", - "name": "act_name", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3009 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='actName', examples=['my-actor'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1232, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3010 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1233, - "module": "_models", - "name": "username", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3011 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['janedoe'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1234, - "module": "_models", - "name": "act_username", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3012 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='actUsername', examples=['janedoe'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1235, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3013 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1236, - "module": "_models", - "name": "modified_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3014 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1237, - "module": "_models", - "name": "stats", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3015 - } - ], - "type": { - "name": "TaskStats | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "TaskStats", - "target": "1238" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1230, - 1231, - 1234, - 1235, - 1228, - 1227, - 1236, - 1232, - 1237, - 1229, - 1233 - ], - "title": "Properties" - } - ], - "id": 1226, - "module": "_models", - "name": "TaskShort", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3001 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1239, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3020 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1240, - "module": "_models", - "name": "total_runs", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3024 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='totalRuns', examples=[15])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1239, - 1240 - ], - "title": "Properties" - } - ], - "id": 1238, - "module": "_models", - "name": "TaskStats", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3019 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1242, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3029 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1243, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3033 - } - ], - "type": { - "name": "WebhookDispatch", - "type": "reference", - "target": "1386" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1243, - 1242 - ], - "title": "Properties" - } - ], - "id": 1241, - "module": "_models", - "name": "TestWebhookResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3028 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "WebhookDispatchResponse", - "target": "1396", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1245, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3038 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1246, - "module": "_models", - "name": "error", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3042 - } - ], - "type": { - "name": "UnknownBuildTagErrorDetail | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "UnknownBuildTagErrorDetail", - "target": "1247" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1246, - 1245 - ], - "title": "Properties" - } - ], - "id": 1244, - "module": "_models", - "name": "UnknownBuildTagError", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3037 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1248, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3047 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "overwrites": { - "name": "ErrorDetail.model_config", - "target": 552, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Machine-processable error type identifier." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1249, - "module": "_models", - "name": "type", - "parsedDocstring": { - "text": "Machine-processable error type identifier." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3051 - } - ], - "type": { - "name": "Literal", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "unknown-build-tag" - } - ] - }, - "overwrites": { - "name": "ErrorDetail.type", - "target": 553, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable error message describing what went wrong." - } - ] - }, - "flags": {}, - "groups": [], - "id": 4049, - "module": "_models", - "name": "message", - "parsedDocstring": { - "text": "Human-readable error message describing what went wrong." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1007 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ErrorDetail.message", - "target": 554, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4049, - 1248, - 1249 - ], - "title": "Properties" - } - ], - "id": 1247, - "module": "_models", - "name": "UnknownBuildTagErrorDetail", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3046 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ErrorDetail", - "target": "551", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1251, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3061 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1252, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3065 - } - ], - "type": { - "name": "UnlockRequestsResult", - "type": "reference", - "target": "1253" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response containing the result of unlocking requests." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1252, - 1251 - ], - "title": "Properties" - } - ], - "id": 1250, - "module": "_models", - "name": "UnlockRequestsResponse", - "parsedDocstring": { - "text": "Response containing the result of unlocking requests." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3058 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1254, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3072 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of requests that were successfully unlocked." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1255, - "module": "_models", - "name": "unlocked_count", - "parsedDocstring": { - "text": "Number of requests that were successfully unlocked." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3076 - } - ], - "type": { - "name": "int", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Result of unlocking requests in the request queue." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1254, - 1255 - ], - "title": "Properties" - } - ], - "id": 1253, - "module": "_models", - "name": "UnlockRequestsResult", - "parsedDocstring": { - "text": "Result of unlocking requests in the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3069 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1257, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3084 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1258, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3088 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['MyActor'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1259, - "module": "_models", - "name": "description", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3089 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['My favourite actor!'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1260, - "module": "_models", - "name": "is_public", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3090 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='isPublic', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1261, - "module": "_models", - "name": "actor_permission_level", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3091 - } - ], - "type": { - "name": "Annotated[ActorPermissionLevel | None, Field(alias='actorPermissionLevel')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorPermissionLevel", - "target": "1795" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1262, - "module": "_models", - "name": "seo_title", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3092 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='seoTitle', examples=['My actor'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1263, - "module": "_models", - "name": "seo_description", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3093 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='seoDescription', examples=['My actor is the best'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1264, - "module": "_models", - "name": "title", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3094 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['My Actor'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1265, - "module": "_models", - "name": "restart_on_error", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3095 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='restartOnError', deprecated=True, examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1266, - "module": "_models", - "name": "versions", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3096 - } - ], - "type": { - "name": "list[CreateOrUpdateVersionRequest] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "CreateOrUpdateVersionRequest", - "target": "393" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1267, - "module": "_models", - "name": "pricing_infos", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3097 - } - ], - "type": { - "name": "Annotated[ list[ Annotated[ PayPerEventActorPricingInfo | PricePerDatasetItemActorPricingInfo | FlatPricePerMonthActorPricingInfo | FreeActorPricingInfo, Field(discriminator='pricing_model'), ] ] | None, Field(alias='pricingInfos'), ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "PayPerEventActorPricingInfo", - "target": "786" - }, - { - "type": "reference", - "name": "PricePerDatasetItemActorPricingInfo", - "target": "813" - } - ] - }, - { - "type": "reference", - "name": "FlatPricePerMonthActorPricingInfo", - "target": "570" - } - ] - }, - { - "type": "reference", - "name": "FreeActorPricingInfo", - "target": "575" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1268, - "module": "_models", - "name": "categories", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3110 - } - ], - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1269, - "module": "_models", - "name": "default_run_options", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3111 - } - ], - "type": { - "name": "Annotated[DefaultRunOptions | None, Field(alias='defaultRunOptions')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "DefaultRunOptions", - "target": "499" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object to modify tags on the Actor's builds. The key is the tag name (e.g., _latest_), and the value is either an object with a `buildId` or `null`.\n\nThis operation is a patch; any existing tags that you omit from this object will be preserved.\n\n- **To create or reassign a tag**, provide the tag name with a `buildId`. e.g., to assign the _latest_ tag:\n\n \n\n ```json\n {\n \"latest\": {\n \"buildId\": \"z2EryhbfhgSyqj6Hn\"\n }\n }\n ```\n\n\n- **To remove a tag**, provide the tag name with a `null` value. e.g., to remove the _beta_ tag:\n\n \n\n ```json\n {\n \"beta\": null\n }\n ```\n\n\n- **To perform multiple operations**, combine them. The following reassigns _latest_ and removes _beta_, while preserving any other existing tags.\n\n \n\n ```json\n {\n \"latest\": {\n \"buildId\": \"z2EryhbfhgSyqj6Hn\"\n },\n \"beta\": null\n }\n ```" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1270, - "module": "_models", - "name": "tagged_builds", - "parsedDocstring": { - "text": "An object to modify tags on the Actor's builds. The key is the tag name (e.g., _latest_), and the value is either an object with a `buildId` or `null`.\n\nThis operation is a patch; any existing tags that you omit from this object will be preserved.\n\n- **To create or reassign a tag**, provide the tag name with a `buildId`. e.g., to assign the _latest_ tag:\n\n \n\n ```json\n {\n \"latest\": {\n \"buildId\": \"z2EryhbfhgSyqj6Hn\"\n }\n }\n ```\n\n\n- **To remove a tag**, provide the tag name with a `null` value. e.g., to remove the _beta_ tag:\n\n \n\n ```json\n {\n \"beta\": null\n }\n ```\n\n\n- **To perform multiple operations**, combine them. The following reassigns _latest_ and removes _beta_, while preserving any other existing tags.\n\n \n\n ```json\n {\n \"latest\": {\n \"buildId\": \"z2EryhbfhgSyqj6Hn\"\n },\n \"beta\": null\n }\n ```" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3112 - } - ], - "type": { - "name": "Annotated[ dict[str, Any] | None, Field(alias='taggedBuilds', examples=[{'latest': {'buildId': 'z2EryhbfhgSyqj6Hn'}, 'beta': None}]), ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1271, - "module": "_models", - "name": "actor_standby", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3157 - } - ], - "type": { - "name": "Annotated[ActorStandby | None, Field(alias='actorStandby')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorStandby", - "target": "255" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1272, - "module": "_models", - "name": "example_run_input", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3158 - } - ], - "type": { - "name": "Annotated[ExampleRunInput | None, Field(alias='exampleRunInput')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ExampleRunInput", - "target": "562" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1273, - "module": "_models", - "name": "is_deprecated", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3159 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='isDeprecated')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1261, - 1271, - 1268, - 1269, - 1259, - 1272, - 1273, - 1260, - 1257, - 1258, - 1267, - 1265, - 1263, - 1262, - 1270, - 1264, - 1266 - ], - "title": "Properties" - } - ], - "id": 1256, - "module": "_models", - "name": "UpdateActorRequest", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3083 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1275, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3164 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1276, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3168 - } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1277, - "module": "_models", - "name": "general_access", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3169 - } - ], - "type": { - "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "GeneralAccess", - "target": "1797" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1277, - 1275, - 1276 - ], - "title": "Properties" - } - ], - "id": 1274, - "module": "_models", - "name": "UpdateDatasetRequest", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3163 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "UpdateStoreRequest", - "target": "1295", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1279, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3174 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "If your platform usage in the billing period exceeds the prepaid usage, you will be charged extra. Setting this property you can update your hard limit on monthly platform usage to prevent accidental overage or to limit the extra charges." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1280, - "module": "_models", - "name": "max_monthly_usage_usd", - "parsedDocstring": { - "text": "If your platform usage in the billing period exceeds the prepaid usage, you will be charged extra. Setting this property you can update your hard limit on monthly platform usage to prevent accidental overage or to limit the extra charges." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3178 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='maxMonthlyUsageUsd', examples=[300])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Apify securely stores your ten most recent Actor runs indefinitely, ensuring they are always accessible. Unnamed storages and other Actor runs are automatically deleted after the retention period. If you're subscribed, you can change it to keep data for longer or to limit your usage. [Lear more](https://docs.apify.com/platform/storage/usage#data-retention)." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1281, - "module": "_models", - "name": "data_retention_days", - "parsedDocstring": { - "text": "Apify securely stores your ten most recent Actor runs indefinitely, ensuring they are always accessible. Unnamed storages and other Actor runs are automatically deleted after the retention period. If you're subscribed, you can change it to keep data for longer or to limit your usage. [Lear more](https://docs.apify.com/platform/storage/usage#data-retention)." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3183 - } - ], - "type": { - "name": "Annotated[int | None, Field(alias='dataRetentionDays', examples=[90])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1281, - 1280, - 1279 - ], - "title": "Properties" - } - ], - "id": 1278, - "module": "_models", - "name": "UpdateLimitsRequest", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3173 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1283, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3194 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new name for the request queue." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1284, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "The new name for the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3198 - } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1285, - "module": "_models", - "name": "general_access", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3202 - } - ], - "type": { - "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "GeneralAccess", - "target": "1797" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request object for updating a request queue." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1285, - 1283, - 1284 - ], - "title": "Properties" - } - ], - "id": 1282, - "module": "_models", - "name": "UpdateRequestQueueRequest", - "parsedDocstring": { - "text": "Request object for updating a request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3191 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1287, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3209 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1288, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3213 - } - ], - "type": { - "name": "RequestRegistration", - "type": "reference", - "target": "948" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response containing the result of updating a request in the request queue." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1288, - 1287 - ], - "title": "Properties" - } - ], - "id": 1286, - "module": "_models", - "name": "UpdateRequestResponse", - "parsedDocstring": { - "text": "Response containing the result of updating a request in the request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3206 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1290, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3218 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1291, - "module": "_models", - "name": "run_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3222 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='runId', examples=['3KH8gEpp4d8uQSe8T'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1292, - "module": "_models", - "name": "status_message", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3223 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='statusMessage', examples=['Actor has finished'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1293, - "module": "_models", - "name": "is_status_message_terminal", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3224 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='isStatusMessageTerminal', examples=[True])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1294, - "module": "_models", - "name": "general_access", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3225 - } - ], - "type": { - "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "GeneralAccess", - "target": "1797" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1294, - 1293, - 1290, - 1291, - 1292 - ], - "title": "Properties" - } - ], - "id": 1289, - "module": "_models", - "name": "UpdateRunRequest", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3217 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4022, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3164 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "inheritedFrom": { - "name": "UpdateDatasetRequest.model_config", - "target": 1275, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4023, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3168 - } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "UpdateDatasetRequest.name", - "target": 1276, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4024, - "module": "_models", - "name": "general_access", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3169 - } - ], - "type": { - "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "GeneralAccess", - "target": "1797" - }, - { - "type": "literal", - "value": null - } - ] - }, - "inheritedFrom": { - "name": "UpdateDatasetRequest.general_access", - "target": 1277, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4024, - 4022, - 4023 - ], - "title": "Properties" - } - ], - "id": 1295, - "module": "_models", - "name": "UpdateStoreRequest", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3229 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "UpdateDatasetRequest", - "target": "1274", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1297, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3235 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1298, - "module": "_models", - "name": "name", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3239 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['my-task'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1299, - "module": "_models", - "name": "options", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3240 - } - ], - "type": { - "name": "TaskOptions | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "TaskOptions", - "target": "1215" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1300, - "module": "_models", - "name": "input", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3241 - } - ], - "type": { - "name": "TaskInput | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "TaskInput", - "target": "1213" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1301, - "module": "_models", - "name": "title", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3242 - } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1302, - "module": "_models", - "name": "actor_standby", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3243 - } - ], - "type": { - "name": "Annotated[ActorStandby | None, Field(alias='actorStandby')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorStandby", - "target": "255" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1302, - 1300, - 1297, - 1298, - 1299, - 1301 - ], - "title": "Properties" - } - ], - "id": 1296, - "module": "_models", - "name": "UpdateTaskRequest", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3234 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1304, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3248 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1305, - "module": "_models", - "name": "start_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3252 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1306, - "module": "_models", - "name": "end_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3253 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1306, - 1304, - 1305 - ], - "title": "Properties" - } - ], - "id": 1303, - "module": "_models", - "name": "UsageCycle", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3247 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1308, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3258 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1309, - "module": "_models", - "name": "quantity", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3262 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1310, - "module": "_models", - "name": "base_amount_usd", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3263 - } - ], - "type": { - "name": "float", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1311, - "module": "_models", - "name": "base_unit_price_usd", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3264 - } - ], - "type": { - "name": "Annotated[float | None, Field(alias='baseUnitPriceUsd', examples=[0.25])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1312, - "module": "_models", - "name": "amount_after_volume_discount_usd", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3265 - } - ], - "type": { - "name": "Annotated[ float | None, Field(alias='amountAfterVolumeDiscountUsd', examples=[0.69611875]) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1313, - "module": "_models", - "name": "price_tiers", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3268 - } - ], - "type": { - "name": "Annotated[list[PriceTiers] | None, Field(alias='priceTiers')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "PriceTiers", - "target": "818" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1312, - 1310, - 1311, - 1308, - 1313, - 1309 - ], - "title": "Properties" - } - ], - "id": 1307, - "module": "_models", - "name": "UsageItem", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3257 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1315, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3273 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1316, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3277 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1317, - "module": "_models", - "name": "username", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3278 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1318, - "module": "_models", - "name": "profile", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3279 - } - ], - "type": { - "name": "Profile", - "type": "reference", - "target": "831" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1319, - "module": "_models", - "name": "email", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3280 - } - ], - "type": { - "name": "EmailStr", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1320, - "module": "_models", - "name": "proxy", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3281 - } - ], - "type": { - "name": "Proxy", - "type": "reference", - "target": "842" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1321, - "module": "_models", - "name": "plan", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3282 - } - ], - "type": { - "name": "Plan", - "type": "reference", - "target": "791" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1322, - "module": "_models", - "name": "effective_platform_features", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3283 - } - ], - "type": { - "name": "EffectivePlatformFeatures", - "type": "reference", - "target": "522" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1323, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3284 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1324, - "module": "_models", - "name": "is_paying", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3285 - } - ], - "type": { - "name": "bool", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1323, - 1322, - 1319, - 1316, - 1324, - 1315, - 1321, - 1318, - 1320, - 1317 - ], - "title": "Properties" - } - ], - "id": 1314, - "module": "_models", - "name": "UserPrivateInfo", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3272 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1326, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3290 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1327, - "module": "_models", - "name": "username", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3294 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1328, - "module": "_models", - "name": "profile", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3295 - } - ], - "type": { - "name": "Profile | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Profile", - "target": "831" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1326, - 1328, - 1327 - ], - "title": "Properties" - } - ], - "id": 1325, - "module": "_models", - "name": "UserPublicInfo", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3289 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1330, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3300 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The path to the instance being validated." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1331, - "module": "_models", - "name": "instance_path", - "parsedDocstring": { - "text": "The path to the instance being validated." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3304 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='instancePath')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The path to the schema that failed the validation." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1332, - "module": "_models", - "name": "schema_path", - "parsedDocstring": { - "text": "The path to the schema that failed the validation." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3308 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='schemaPath')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The validation keyword that caused the error." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1333, - "module": "_models", - "name": "keyword", - "parsedDocstring": { - "text": "The validation keyword that caused the error." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3312 - } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A message describing the validation error." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1334, - "module": "_models", - "name": "message", - "parsedDocstring": { - "text": "A message describing the validation error." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3316 - } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional parameters specific to the validation error." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1335, - "module": "_models", - "name": "params", - "parsedDocstring": { - "text": "Additional parameters specific to the validation error." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3320 - } - ], - "type": { - "name": "dict[str, Any] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1331, - 1333, - 1334, - 1330, - 1335, - 1332 - ], - "title": "Properties" - } - ], - "id": 1329, - "module": "_models", - "name": "ValidationError", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3299 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1337, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3328 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1338, - "module": "_models", - "name": "version_number", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3332 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1339, - "module": "_models", - "name": "source_type", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3333 - } - ], - "type": { - "name": "Annotated[VersionSourceType | None, Field(alias='sourceType')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "VersionSourceType", - "target": "1802" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1340, - "module": "_models", - "name": "env_vars", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3334 - } - ], - "type": { - "name": "Annotated[list[EnvVar] | None, Field(alias='envVars')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "EnvVar", - "target": "541" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1341, - "module": "_models", - "name": "apply_env_vars_to_build", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3335 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='applyEnvVarsToBuild', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1342, - "module": "_models", - "name": "build_tag", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3336 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='buildTag', examples=['latest'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1343, - "module": "_models", - "name": "source_files", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3337 - } - ], - "type": { - "name": "Annotated[ list[SourceCodeFile | SourceCodeFolder] | None, Field(alias='sourceFiles', title='VersionSourceFiles') ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "SourceCodeFile", - "target": "1158" - }, - { - "type": "reference", - "name": "SourceCodeFolder", - "target": "1163" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the Git repository when sourceType is GIT_REPO." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1344, - "module": "_models", - "name": "git_repo_url", - "parsedDocstring": { - "text": "URL of the Git repository when sourceType is GIT_REPO." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3340 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='gitRepoUrl')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the tarball when sourceType is TARBALL." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1345, - "module": "_models", - "name": "tarball_url", - "parsedDocstring": { - "text": "URL of the tarball when sourceType is TARBALL." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3344 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='tarballUrl')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL of the GitHub Gist when sourceType is GITHUB_GIST." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1346, - "module": "_models", - "name": "github_gist_url", - "parsedDocstring": { - "text": "URL of the GitHub Gist when sourceType is GITHUB_GIST." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3348 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='gitHubGistUrl')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1341, - 1342, - 1340, - 1344, - 1346, - 1337, - 1343, - 1339, - 1345, - 1338 - ], - "title": "Properties" - } - ], - "id": 1336, - "module": "_models", - "name": "Version", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3327 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1348, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3356 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1349, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3360 - } - ], - "type": { - "name": "Version", - "type": "reference", - "target": "1336" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1349, - 1348 - ], - "title": "Properties" - } - ], - "id": 1347, - "module": "_models", - "name": "VersionResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3355 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1351, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3365 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1352, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3369 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1353, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3370 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1354, - "module": "_models", - "name": "modified_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3371 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1355, - "module": "_models", - "name": "user_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3372 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1356, - "module": "_models", - "name": "is_ad_hoc", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3373 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='isAdHoc', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1357, - "module": "_models", - "name": "should_interpolate_strings", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3374 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='shouldInterpolateStrings', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1358, - "module": "_models", - "name": "event_types", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3375 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookEventType", - "target": "1804" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1359, - "module": "_models", - "name": "condition", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3376 - } - ], - "type": { - "name": "WebhookCondition", - "type": "reference", - "target": "1368" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1360, - "module": "_models", - "name": "ignore_ssl_errors", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3377 - } - ], - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1361, - "module": "_models", - "name": "do_not_retry", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3378 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='doNotRetry', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1362, - "module": "_models", - "name": "request_url", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3379 - } - ], - "type": { - "name": "AnyUrl", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1363, - "module": "_models", - "name": "payload_template", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3380 - } - ], - "type": { - "name": "Annotated[ str | None, Field(alias='payloadTemplate', examples=['{\\\\n \"userId\": {{userId}}...']) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1364, - "module": "_models", - "name": "headers_template", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3383 - } - ], - "type": { - "name": "Annotated[ str | None, Field(alias='headersTemplate', examples=['{\\\\n \"Authorization\": \"Bearer ...\"}']) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1365, - "module": "_models", - "name": "description", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3386 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['this is webhook description'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1366, - "module": "_models", - "name": "last_dispatch", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3387 - } - ], - "type": { - "name": "Annotated[ExampleWebhookDispatch | None, Field(alias='lastDispatch')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ExampleWebhookDispatch", - "target": "566" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1367, - "module": "_models", - "name": "stats", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3388 - } - ], - "type": { - "name": "WebhookStats | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "WebhookStats", - "target": "1421" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1359, - 1353, - 1365, - 1361, - 1358, - 1364, - 1352, - 1360, - 1356, - 1366, - 1351, - 1354, - 1363, - 1362, - 1357, - 1367, - 1355 - ], - "title": "Properties" - } - ], - "id": 1350, - "module": "_models", - "name": "Webhook", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3364 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1369, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3393 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1370, - "module": "_models", - "name": "actor_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3397 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='actorId', examples=['hksJZtadYvn4mBuin'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1371, - "module": "_models", - "name": "actor_task_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3398 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='actorTaskId', examples=['asdLZtadYvn4mBZmm'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1372, - "module": "_models", - "name": "actor_run_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3399 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='actorRunId', examples=['hgdKZtadYvn4mBpoi'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1370, - 1372, - 1371, - 1369 - ], - "title": "Properties" - } - ], - "id": 1368, - "module": "_models", - "name": "WebhookCondition", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3392 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1374, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3404 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1375, - "module": "_models", - "name": "is_ad_hoc", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3408 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='isAdHoc', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1376, - "module": "_models", - "name": "event_types", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3409 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookEventType", - "target": "1804" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1377, - "module": "_models", - "name": "condition", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3410 - } - ], - "type": { - "name": "WebhookCondition", - "type": "reference", - "target": "1368" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1378, - "module": "_models", - "name": "idempotency_key", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3411 - } - ], - "type": { - "name": "Annotated[str | None, Field(alias='idempotencyKey', examples=['fdSJmdP3nfs7sfk3y'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1379, - "module": "_models", - "name": "ignore_ssl_errors", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3412 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='ignoreSslErrors', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1380, - "module": "_models", - "name": "do_not_retry", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3413 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='doNotRetry', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1381, - "module": "_models", - "name": "request_url", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3414 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1382, - "module": "_models", - "name": "payload_template", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3415 - } - ], - "type": { - "name": "Annotated[ str | None, Field(alias='payloadTemplate', examples=['{\\\\n \"userId\": {{userId}}...']) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1383, - "module": "_models", - "name": "headers_template", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3418 - } - ], - "type": { - "name": "Annotated[ str | None, Field(alias='headersTemplate', examples=['{\\\\n \"Authorization\": \"Bearer ...\"}']) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1384, - "module": "_models", - "name": "description", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3421 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['this is webhook description'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1385, - "module": "_models", - "name": "should_interpolate_strings", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3422 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='shouldInterpolateStrings', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1377, - 1384, - 1380, - 1376, - 1383, - 1378, - 1379, - 1375, - 1374, - 1382, - 1381, - 1385 - ], - "title": "Properties" - } - ], - "id": 1373, - "module": "_models", - "name": "WebhookCreate", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3403 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1387, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3427 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1388, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3431 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1389, - "module": "_models", - "name": "user_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3432 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1390, - "module": "_models", - "name": "webhook_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3433 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1391, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3434 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1392, - "module": "_models", - "name": "status", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3435 - } - ], - "type": { - "name": "WebhookDispatchStatus", - "type": "reference", - "target": "1803" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1393, - "module": "_models", - "name": "event_type", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3436 - } - ], - "type": { - "name": "WebhookEventType", - "type": "reference", - "target": "1804" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1394, - "module": "_models", - "name": "event_data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3437 - } - ], - "type": { - "name": "Annotated[EventData | None, Field(alias='eventData', title='eventData')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "EventData", - "target": "558" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1395, - "module": "_models", - "name": "calls", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3438 - } - ], - "type": { - "name": "Annotated[list[Call] | None, Field(title='calls')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "Call", - "target": "358" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1395, - 1391, - 1394, - 1393, - 1388, - 1387, - 1392, - 1389, - 1390 - ], - "title": "Properties" - } - ], - "id": 1386, - "module": "_models", - "name": "WebhookDispatch", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3426 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4020, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3029 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "inheritedFrom": { - "name": "TestWebhookResponse.model_config", - "target": 1242, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 4021, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3033 - } - ], - "type": { - "name": "WebhookDispatch", - "type": "reference", - "target": "1386" - }, - "inheritedFrom": { - "name": "TestWebhookResponse.data", - "target": 1243, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4021, - 4020 - ], - "title": "Properties" - } - ], - "id": 1396, - "module": "_models", - "name": "WebhookDispatchResponse", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3442 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "TestWebhookResponse", - "target": "1241", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1398, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3454 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1399, - "module": "_models", - "name": "event_types", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3458 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookEventType", - "target": "1804" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL to which the webhook sends its payload." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1400, - "module": "_models", - "name": "request_url", - "parsedDocstring": { - "text": "The URL to which the webhook sends its payload." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3459 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional template for the JSON payload sent by the webhook." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1401, - "module": "_models", - "name": "payload_template", - "parsedDocstring": { - "text": "Optional template for the JSON payload sent by the webhook." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3463 - } - ], - "type": { - "name": "Annotated[ str | None, Field(alias='payloadTemplate', examples=['{\\\\n \"userId\": {{userId}}...']) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional template for the HTTP headers sent by the webhook." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1402, - "module": "_models", - "name": "headers_template", - "parsedDocstring": { - "text": "Optional template for the HTTP headers sent by the webhook." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3469 - } - ], - "type": { - "name": "Annotated[ str | None, Field(alias='headersTemplate', examples=['{\\\\n \"Authorization\": \"Bearer ...\"}']) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1399, - 1402, - 1398, - 1401, - 1400 - ], - "title": "Properties" - } - ], - "id": 1397, - "module": "_models", - "name": "WebhookRepresentation", - "parsedDocstring": { - "text": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3447 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1404, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3481 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1405, - "module": "_models", - "name": "data", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3485 - } - ], - "type": { - "name": "Webhook", - "type": "reference", - "target": "1350" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response containing webhook data." - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1405, - 1404 - ], - "title": "Properties" - } - ], - "id": 1403, - "module": "_models", - "name": "WebhookResponse", - "parsedDocstring": { - "text": "Response containing webhook data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3478 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1407, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3490 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1408, - "module": "_models", - "name": "id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3494 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1409, - "module": "_models", - "name": "created_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3495 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1410, - "module": "_models", - "name": "modified_at", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3496 - } - ], - "type": { - "name": "AwareDatetime", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1411, - "module": "_models", - "name": "user_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3497 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1412, - "module": "_models", - "name": "is_ad_hoc", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3498 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='isAdHoc', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1413, - "module": "_models", - "name": "should_interpolate_strings", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3499 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='shouldInterpolateStrings', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1414, - "module": "_models", - "name": "event_types", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3500 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookEventType", - "target": "1804" - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1415, - "module": "_models", - "name": "condition", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3501 - } - ], - "type": { - "name": "WebhookCondition", - "type": "reference", - "target": "1368" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1416, - "module": "_models", - "name": "ignore_ssl_errors", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3502 - } - ], - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1417, - "module": "_models", - "name": "do_not_retry", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3503 - } - ], - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1418, - "module": "_models", - "name": "request_url", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3504 - } - ], - "type": { - "name": "AnyUrl", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1419, - "module": "_models", - "name": "last_dispatch", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3505 - } - ], - "type": { - "name": "Annotated[ExampleWebhookDispatch | None, Field(alias='lastDispatch')]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ExampleWebhookDispatch", - "target": "566" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1420, - "module": "_models", - "name": "stats", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3506 - } - ], - "type": { - "name": "WebhookStats | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "WebhookStats", - "target": "1421" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1415, - 1409, - 1417, - 1414, - 1408, - 1416, - 1412, - 1419, - 1407, - 1410, - 1418, - 1413, - 1420, - 1411 - ], - "title": "Properties" - } - ], - "id": 1406, - "module": "_models", - "name": "WebhookShort", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3489 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1422, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3511 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1423, - "module": "_models", - "name": "total_dispatches", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3515 - } - ], - "type": { - "name": "int", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1422, - 1423 - ], - "title": "Properties" - } - ], - "id": 1421, - "module": "_models", - "name": "WebhookStats", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3510 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1425, - "module": "_models", - "name": "model_config", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3520 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1426, - "module": "_models", - "name": "is_ad_hoc", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3524 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='isAdHoc', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1427, - "module": "_models", - "name": "event_types", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3525 - } - ], - "type": { - "name": "Annotated[ list[WebhookEventType] | None, Field(alias='eventTypes', examples=[['ACTOR.RUN.SUCCEEDED']]) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookEventType", - "target": "1804" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1428, - "module": "_models", - "name": "condition", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3528 - } - ], - "type": { - "name": "WebhookCondition | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "WebhookCondition", - "target": "1368" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1429, - "module": "_models", - "name": "ignore_ssl_errors", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3529 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='ignoreSslErrors', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1430, - "module": "_models", - "name": "do_not_retry", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3530 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='doNotRetry', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1431, - "module": "_models", - "name": "request_url", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3531 - } - ], - "type": { - "name": "Annotated[AnyUrl | None, Field(alias='requestUrl', examples=['http://example.com/'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AnyUrl" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1432, - "module": "_models", - "name": "payload_template", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3532 - } - ], - "type": { - "name": "Annotated[ str | None, Field(alias='payloadTemplate', examples=['{\\\\n \"userId\": {{userId}}...']) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1433, - "module": "_models", - "name": "headers_template", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3535 - } - ], - "type": { - "name": "Annotated[ str | None, Field(alias='headersTemplate', examples=['{\\\\n \"Authorization\": \"Bearer ...\"}']) ]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1434, - "module": "_models", - "name": "description", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3538 - } - ], - "type": { - "name": "Annotated[str | None, Field(examples=['this is webhook description'])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1435, - "module": "_models", - "name": "should_interpolate_strings", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3539 - } - ], - "type": { - "name": "Annotated[bool | None, Field(alias='shouldInterpolateStrings', examples=[False])]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [ - { - "args": "('Models')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1428, - 1434, - 1430, - 1427, - 1433, - 1429, - 1426, - 1425, - 1432, - 1431, - 1435 - ], - "title": "Properties" - } - ], - "id": 1424, - "module": "_models", - "name": "WebhookUpdate", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_models.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 3519 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the Apify API client.\n\nTo use a custom HTTP client, use the `with_custom_http_client` class method instead.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1437, - "module": "_apify_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the Apify API client.\n\nTo use a custom HTTP client, use the `with_custom_http_client` class method instead.\n", - "args": { - "token": "The Apify API token. You can find your token on the\n[Integrations](https://console.apify.com/account/integrations) page in the Apify Console.", - "api_url": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com. It can\nbe an internal URL that is not globally accessible, in which case `api_public_url` should be set\nas well.", - "api_public_url": "The globally accessible URL of the Apify API server. Should be set only if `api_url`\nis an internal URL that is not globally accessible. Defaults to https://api.apify.com.", - "max_retries": "How many times to retry a failed request at most.", - "min_delay_between_retries": "How long will the client wait between retrying requests\n(increases exponentially from this value).", - "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).", - "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).", - "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).", - "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.", - "headers": "Additional HTTP headers to include in all API requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 112 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the Apify API client.\n\nTo use a custom HTTP client, use the `with_custom_http_client` class method instead.\n" - } - ] - }, - "flags": {}, - "id": 1438, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Apify API token. You can find your token on the\n[Integrations](https://console.apify.com/account/integrations) page in the Apify Console." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 1439, - "kind": 32768, - "kindString": "Parameter", - "name": "token", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com. It can\nbe an internal URL that is not globally accessible, in which case `api_public_url` should be set\nas well." - } - ] - }, - "defaultValue": "DEFAULT_API_URL", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1440, - "kind": 32768, - "kindString": "Parameter", - "name": "api_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The globally accessible URL of the Apify API server. Should be set only if `api_url`\nis an internal URL that is not globally accessible. Defaults to https://api.apify.com." - } - ] - }, - "defaultValue": "DEFAULT_API_URL", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1441, - "kind": 32768, - "kindString": "Parameter", - "name": "api_public_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many times to retry a failed request at most." - } - ] - }, - "defaultValue": "DEFAULT_MAX_RETRIES", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1442, - "kind": 32768, - "kindString": "Parameter", - "name": "max_retries", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How long will the client wait between retrying requests\n(increases exponentially from this value)." - } - ] - }, - "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1443, - "kind": 32768, - "kindString": "Parameter", - "name": "min_delay_between_retries", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_SHORT", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1444, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_short", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_MEDIUM", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1445, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_medium", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_LONG", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1446, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_long", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum timeout cap for exponential timeout growth across retries." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_MAX", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1447, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_max", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional HTTP headers to include in all API requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1448, - "kind": 32768, - "kindString": "Parameter", - "name": "headers", - "type": { - "name": "dict[str, str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "str" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create an `ApifyClient` instance with a custom HTTP client.\n\nUse this alternative constructor when you want to provide your own HTTP client implementation\ninstead of the default one. The custom client is responsible for its own configuration\n(retries, timeouts, headers, etc.).\n\n### Usage\n\n```python\nfrom apify_client import ApifyClient\nfrom apify_client.http_clients import HttpClient, HttpResponse\n\nclass MyHttpClient(HttpClient):\n def call(self, *, method, url, **kwargs) -> HttpResponse:\n ...\n\nclient = ApifyClient.with_custom_http_client(\n token='MY-APIFY-TOKEN',\n http_client=MyHttpClient(),\n)\n```" - } - ] - }, - "decorations": [ - { - "name": "classmethod" - } - ], - "flags": {}, - "groups": [], - "id": 1449, - "module": "_apify_client", - "name": "with_custom_http_client", - "parsedDocstring": { - "text": "Create an `ApifyClient` instance with a custom HTTP client.\n\nUse this alternative constructor when you want to provide your own HTTP client implementation\ninstead of the default one. The custom client is responsible for its own configuration\n(retries, timeouts, headers, etc.).\n\n### Usage\n\n```python\nfrom apify_client import ApifyClient\nfrom apify_client.http_clients import HttpClient, HttpResponse\n\nclass MyHttpClient(HttpClient):\n def call(self, *, method, url, **kwargs) -> HttpResponse:\n ...\n\nclient = ApifyClient.with_custom_http_client(\n token='MY-APIFY-TOKEN',\n http_client=MyHttpClient(),\n)\n```", - "args": { - "token": "The Apify API token.", - "api_url": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com.", - "api_public_url": "The globally accessible URL of the Apify API server. Defaults to https://api.apify.com.", - "http_client": "A custom HTTP client instance extending `HttpClient`." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 210 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create an `ApifyClient` instance with a custom HTTP client.\n\nUse this alternative constructor when you want to provide your own HTTP client implementation\ninstead of the default one. The custom client is responsible for its own configuration\n(retries, timeouts, headers, etc.).\n\n### Usage\n\n```python\nfrom apify_client import ApifyClient\nfrom apify_client.http_clients import HttpClient, HttpResponse\n\nclass MyHttpClient(HttpClient):\n def call(self, *, method, url, **kwargs) -> HttpResponse:\n ...\n\nclient = ApifyClient.with_custom_http_client(\n token='MY-APIFY-TOKEN',\n http_client=MyHttpClient(),\n)\n```" - } - ] - }, - "flags": {}, - "id": 1450, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "with_custom_http_client", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Apify API token." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 1451, - "kind": 32768, - "kindString": "Parameter", - "name": "token", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com." - } - ] - }, - "defaultValue": "DEFAULT_API_URL", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1452, - "kind": 32768, - "kindString": "Parameter", - "name": "api_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The globally accessible URL of the Apify API server. Defaults to https://api.apify.com." - } - ] - }, - "defaultValue": "DEFAULT_API_URL", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1453, - "kind": 32768, - "kindString": "Parameter", - "name": "api_public_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom HTTP client instance extending `HttpClient`." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 1454, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - } - ], - "type": { - "name": "ApifyClient", - "type": "reference", - "target": "1436" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Apify API token used by the client." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 1455, - "module": "_apify_client", - "name": "token", - "parsedDocstring": { - "text": "The Apify API token used by the client." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 251 - } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP client instance used for API communication.\n\nReturns the custom HTTP client if one was provided via `with_custom_http_client`,\nor the default `ImpitHttpClient` otherwise (lazily created on first access)." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 1456, - "module": "_apify_client", - "name": "http_client", - "parsedDocstring": { - "text": "The HTTP client instance used for API communication.\n\nReturns the custom HTTP client if one was provided via `with_custom_http_client`,\nor the default `ImpitHttpClient` otherwise (lazily created on first access)." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 256 - } - ], - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific Actor.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1457, - "module": "_apify_client", - "name": "actor", - "parsedDocstring": { - "text": "Get the sub-client for a specific Actor.\n", - "args": { - "actor_id": "ID of the Actor to be manipulated." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 287 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific Actor.\n" - } - ] - }, - "flags": {}, - "id": 1458, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "actor", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the Actor to be manipulated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1459, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "ActorClient", - "type": "reference", - "target": "3404" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the Actor collection, allowing to list and create Actors." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1460, - "module": "_apify_client", - "name": "actors", - "parsedDocstring": { - "text": "Get the sub-client for the Actor collection, allowing to list and create Actors." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 295 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the Actor collection, allowing to list and create Actors." - } - ] - }, - "flags": {}, - "id": 1461, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "actors", - "parameters": [], - "type": { - "name": "ActorCollectionClient", - "type": "reference", - "target": "2262" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific Actor build.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1462, - "module": "_apify_client", - "name": "build", - "parsedDocstring": { - "text": "Get the sub-client for a specific Actor build.\n", - "args": { - "build_id": "ID of the Actor build to be manipulated." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 299 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific Actor build.\n" - } - ] - }, - "flags": {}, - "id": 1463, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "build", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the Actor build to be manipulated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1464, - "kind": 32768, - "kindString": "Parameter", - "name": "build_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "BuildClient", - "type": "reference", - "target": "3171" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the build collection, allowing to list builds." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1465, - "module": "_apify_client", - "name": "builds", - "parsedDocstring": { - "text": "Get the sub-client for the build collection, allowing to list builds." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 307 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the build collection, allowing to list builds." - } - ] - }, - "flags": {}, - "id": 1466, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "builds", - "parameters": [], - "type": { - "name": "BuildCollectionClient", - "type": "reference", - "target": "2778" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific Actor run.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1467, - "module": "_apify_client", - "name": "run", - "parsedDocstring": { - "text": "Get the sub-client for a specific Actor run.\n", - "args": { - "run_id": "ID of the Actor run to be manipulated." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 311 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific Actor run.\n" - } - ] - }, - "flags": {}, - "id": 1468, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "run", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the Actor run to be manipulated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1469, - "kind": 32768, - "kindString": "Parameter", - "name": "run_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "RunClient", - "type": "reference", - "target": "3033" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the run collection, allowing to list Actor runs." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1470, - "module": "_apify_client", - "name": "runs", - "parsedDocstring": { - "text": "Get the sub-client for the run collection, allowing to list Actor runs." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 319 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the run collection, allowing to list Actor runs." - } - ] - }, - "flags": {}, - "id": 1471, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "runs", - "parameters": [], - "type": { - "name": "RunCollectionClient", - "type": "reference", - "target": "3916" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific dataset.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1472, - "module": "_apify_client", - "name": "dataset", - "parsedDocstring": { - "text": "Get the sub-client for a specific dataset.\n", - "args": { - "dataset_id": "ID of the dataset to be manipulated." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 323 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific dataset.\n" - } - ] - }, - "flags": {}, - "id": 1473, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "dataset", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the dataset to be manipulated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1474, - "kind": 32768, - "kindString": "Parameter", - "name": "dataset_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "DatasetClient", - "type": "reference", - "target": "2819" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the dataset collection, allowing to list and create datasets." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1475, - "module": "_apify_client", - "name": "datasets", - "parsedDocstring": { - "text": "Get the sub-client for the dataset collection, allowing to list and create datasets." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 331 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the dataset collection, allowing to list and create datasets." - } - ] - }, - "flags": {}, - "id": 1476, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "datasets", - "parameters": [], - "type": { - "name": "DatasetCollectionClient", - "type": "reference", - "target": "3321" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific key-value store.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1477, - "module": "_apify_client", - "name": "key_value_store", - "parsedDocstring": { - "text": "Get the sub-client for a specific key-value store.\n", - "args": { - "key_value_store_id": "ID of the key-value store to be manipulated." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 335 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific key-value store.\n" - } - ] - }, - "flags": {}, - "id": 1478, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "key_value_store", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the key-value store to be manipulated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1479, - "kind": 32768, - "kindString": "Parameter", - "name": "key_value_store_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "KeyValueStoreClient", - "type": "reference", - "target": "3608" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the key-value store collection, allowing to list and create key-value stores." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1480, - "module": "_apify_client", - "name": "key_value_stores", - "parsedDocstring": { - "text": "Get the sub-client for the key-value store collection, allowing to list and create key-value stores." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 343 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the key-value store collection, allowing to list and create key-value stores." - } - ] - }, - "flags": {}, - "id": 1481, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "key_value_stores", - "parameters": [], - "type": { - "name": "KeyValueStoreCollectionClient", - "type": "reference", - "target": "2372" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific request queue.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1482, - "module": "_apify_client", - "name": "request_queue", - "parsedDocstring": { - "text": "Get the sub-client for a specific request queue.\n", - "args": { - "request_queue_id": "ID of the request queue to be manipulated.", - "client_key": "A unique identifier of the client accessing the request queue." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 347 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific request queue.\n" - } - ] - }, - "flags": {}, - "id": 1483, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "request_queue", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the request queue to be manipulated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1484, - "kind": 32768, - "kindString": "Parameter", - "name": "request_queue_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier of the client accessing the request queue." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1485, - "kind": 32768, - "kindString": "Parameter", - "name": "client_key", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "RequestQueueClient", - "type": "reference", - "target": "1996" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the request queue collection, allowing to list and create request queues." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1486, - "module": "_apify_client", - "name": "request_queues", - "parsedDocstring": { - "text": "Get the sub-client for the request queue collection, allowing to list and create request queues." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 356 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the request queue collection, allowing to list and create request queues." - } - ] - }, - "flags": {}, - "id": 1487, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "request_queues", - "parameters": [], - "type": { - "name": "RequestQueueCollectionClient", - "type": "reference", - "target": "2480" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific webhook.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1488, - "module": "_apify_client", - "name": "webhook", - "parsedDocstring": { - "text": "Get the sub-client for a specific webhook.\n", - "args": { - "webhook_id": "ID of the webhook to be manipulated." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 360 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific webhook.\n" - } - ] - }, - "flags": {}, - "id": 1489, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "webhook", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the webhook to be manipulated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1490, - "kind": 32768, - "kindString": "Parameter", - "name": "webhook_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "WebhookClient", - "type": "reference", - "target": "3856" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the webhook collection, allowing to list and create webhooks." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1491, - "module": "_apify_client", - "name": "webhooks", - "parsedDocstring": { - "text": "Get the sub-client for the webhook collection, allowing to list and create webhooks." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 368 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the webhook collection, allowing to list and create webhooks." - } - ] - }, - "flags": {}, - "id": 1492, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "webhooks", - "parameters": [], - "type": { - "name": "WebhookCollectionClient", - "type": "reference", - "target": "3794" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific webhook dispatch.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1493, - "module": "_apify_client", - "name": "webhook_dispatch", - "parsedDocstring": { - "text": "Get the sub-client for a specific webhook dispatch.\n", - "args": { - "webhook_dispatch_id": "ID of the webhook dispatch to access." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 372 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific webhook dispatch.\n" - } - ] - }, - "flags": {}, - "id": 1494, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "webhook_dispatch", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the webhook dispatch to access." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1495, - "kind": 32768, - "kindString": "Parameter", - "name": "webhook_dispatch_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "WebhookDispatchClient", - "type": "reference", - "target": "2354" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the webhook dispatch collection, allowing to list webhook dispatches." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1496, - "module": "_apify_client", - "name": "webhook_dispatches", - "parsedDocstring": { - "text": "Get the sub-client for the webhook dispatch collection, allowing to list webhook dispatches." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 380 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the webhook dispatch collection, allowing to list webhook dispatches." - } - ] - }, - "flags": {}, - "id": 1497, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "webhook_dispatches", - "parameters": [], - "type": { - "name": "WebhookDispatchCollectionClient", - "type": "reference", - "target": "2228" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific schedule.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1498, - "module": "_apify_client", - "name": "schedule", - "parsedDocstring": { - "text": "Get the sub-client for a specific schedule.\n", - "args": { - "schedule_id": "ID of the schedule to be manipulated." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 384 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific schedule.\n" - } - ] - }, - "flags": {}, - "id": 1499, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "schedule", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the schedule to be manipulated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1500, - "kind": 32768, - "kindString": "Parameter", - "name": "schedule_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "ScheduleClient", - "type": "reference", - "target": "1904" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the schedule collection, allowing to list and create schedules." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1501, - "module": "_apify_client", - "name": "schedules", - "parsedDocstring": { - "text": "Get the sub-client for the schedule collection, allowing to list and create schedules." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 392 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the schedule collection, allowing to list and create schedules." - } - ] - }, - "flags": {}, - "id": 1502, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "schedules", - "parameters": [], - "type": { - "name": "ScheduleCollectionClient", - "type": "reference", - "target": "3219" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for retrieving logs of an Actor build or run.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1503, - "module": "_apify_client", - "name": "log", - "parsedDocstring": { - "text": "Get the sub-client for retrieving logs of an Actor build or run.\n", - "args": { - "build_or_run_id": "ID of the Actor build or run for which to access the log." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 396 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for retrieving logs of an Actor build or run.\n" - } - ] - }, - "flags": {}, - "id": 1504, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "log", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the Actor build or run for which to access the log." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1505, - "kind": 32768, - "kindString": "Parameter", - "name": "build_or_run_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "LogClient", - "type": "reference", - "target": "2160" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific Actor task.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1506, - "module": "_apify_client", - "name": "task", - "parsedDocstring": { - "text": "Get the sub-client for a specific Actor task.\n", - "args": { - "task_id": "ID of the task to be manipulated." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 404 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific Actor task.\n" - } - ] - }, - "flags": {}, - "id": 1507, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "task", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the task to be manipulated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1508, - "kind": 32768, - "kindString": "Parameter", - "name": "task_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "TaskClient", - "type": "reference", - "target": "2648" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the task collection, allowing to list and create Actor tasks." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1509, - "module": "_apify_client", - "name": "tasks", - "parsedDocstring": { - "text": "Get the sub-client for the task collection, allowing to list and create Actor tasks." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 412 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the task collection, allowing to list and create Actor tasks." - } - ] - }, - "flags": {}, - "id": 1510, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "tasks", - "parameters": [], - "type": { - "name": "TaskCollectionClient", - "type": "reference", - "target": "2530" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for querying user data.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1511, - "module": "_apify_client", - "name": "user", - "parsedDocstring": { - "text": "Get the sub-client for querying user data.\n", - "args": { - "user_id": "ID of user to be queried. If None, queries the user belonging to the token supplied to the client." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 416 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for querying user data.\n" - } - ] - }, - "flags": {}, - "id": 1512, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "user", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of user to be queried. If None, queries the user belonging to the token supplied to the client." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 1513, - "kind": 32768, - "kindString": "Parameter", - "name": "user_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "UserClient", - "type": "reference", - "target": "1956" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the Apify Store, allowing to list Actors published in the store." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1514, - "module": "_apify_client", - "name": "store", - "parsedDocstring": { - "text": "Get the sub-client for the Apify Store, allowing to list Actors published in the store." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 424 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the Apify Store, allowing to list Actors published in the store." - } - ] - }, - "flags": {}, - "id": 1515, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "store", - "parameters": [], - "type": { - "name": "StoreCollectionClient", - "type": "reference", - "target": "2598" - } - } - ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Synchronous client for the Apify API.\n\nThis is the main entry point for interacting with the Apify platform. It provides methods to access\nresource-specific sub-clients for managing Actors, runs, datasets, key-value stores, request queues,\nschedules, webhooks, and more.\n\nThe client automatically handles retries with exponential backoff for failed or rate-limited requests.\n\n### Usage\n\n```python\nfrom apify_client import ApifyClient\n\nclient = ApifyClient(token='MY-APIFY-TOKEN')\n\n# Start an Actor and wait for it to finish.\nactor_client = client.actor('apify/python-example')\nrun = actor_client.call(run_input={'first_number': 1, 'second_number': 2})\n\n# Fetch results from the run's default dataset.\nif run is not None:\n dataset_client = client.dataset(run.default_dataset_id)\n items = dataset_client.list_items().items\n for item in items:\n print(item)\n```" - } - ] - }, - "decorations": [ - { - "args": "('Apify API clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1437, - 1457, - 1460, - 1462, - 1465, - 1472, - 1475, - 1477, - 1480, - 1503, - 1482, - 1486, - 1467, - 1470, - 1498, - 1501, - 1514, - 1506, - 1509, - 1511, - 1488, - 1493, - 1496, - 1491, - 1449 - ], - "title": "Methods" - }, - { - "children": [ - 1456, - 1455 - ], - "title": "Properties" - } - ], - "id": 1436, - "module": "_apify_client", - "name": "ApifyClient", - "parsedDocstring": { - "text": "Synchronous client for the Apify API.\n\nThis is the main entry point for interacting with the Apify platform. It provides methods to access\nresource-specific sub-clients for managing Actors, runs, datasets, key-value stores, request queues,\nschedules, webhooks, and more.\n\nThe client automatically handles retries with exponential backoff for failed or rate-limited requests.\n\n### Usage\n\n```python\nfrom apify_client import ApifyClient\n\nclient = ApifyClient(token='MY-APIFY-TOKEN')\n\n# Start an Actor and wait for it to finish.\nactor_client = client.actor('apify/python-example')\nrun = actor_client.call(run_input={'first_number': 1, 'second_number': 2})\n\n# Fetch results from the run's default dataset.\nif run is not None:\n dataset_client = client.dataset(run.default_dataset_id)\n items = dataset_client.list_items().items\n for item in items:\n print(item)\n```" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 83 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the Apify API client.\n\nTo use a custom HTTP client, use the `with_custom_http_client` class method instead.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1517, - "module": "_apify_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the Apify API client.\n\nTo use a custom HTTP client, use the `with_custom_http_client` class method instead.\n", - "args": { - "token": "The Apify API token. You can find your token on the\n[Integrations](https://console.apify.com/account/integrations) page in the Apify Console.", - "api_url": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com. It can\nbe an internal URL that is not globally accessible, in which case `api_public_url` should be set\nas well.", - "api_public_url": "The globally accessible URL of the Apify API server. Should be set only if `api_url`\nis an internal URL that is not globally accessible. Defaults to https://api.apify.com.", - "max_retries": "How many times to retry a failed request at most.", - "min_delay_between_retries": "How long will the client wait between retrying requests\n(increases exponentially from this value).", - "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).", - "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).", - "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).", - "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.", - "headers": "Additional HTTP headers to include in all API requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 466 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the Apify API client.\n\nTo use a custom HTTP client, use the `with_custom_http_client` class method instead.\n" - } - ] - }, - "flags": {}, - "id": 1518, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Apify API token. You can find your token on the\n[Integrations](https://console.apify.com/account/integrations) page in the Apify Console." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 1519, - "kind": 32768, - "kindString": "Parameter", - "name": "token", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com. It can\nbe an internal URL that is not globally accessible, in which case `api_public_url` should be set\nas well." - } - ] - }, - "defaultValue": "DEFAULT_API_URL", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1520, - "kind": 32768, - "kindString": "Parameter", - "name": "api_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The globally accessible URL of the Apify API server. Should be set only if `api_url`\nis an internal URL that is not globally accessible. Defaults to https://api.apify.com." - } - ] - }, - "defaultValue": "DEFAULT_API_URL", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1521, - "kind": 32768, - "kindString": "Parameter", - "name": "api_public_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many times to retry a failed request at most." - } - ] - }, - "defaultValue": "DEFAULT_MAX_RETRIES", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1522, - "kind": 32768, - "kindString": "Parameter", - "name": "max_retries", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How long will the client wait between retrying requests\n(increases exponentially from this value)." - } - ] - }, - "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1523, - "kind": 32768, - "kindString": "Parameter", - "name": "min_delay_between_retries", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_SHORT", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1524, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_short", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_MEDIUM", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1525, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_medium", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_LONG", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1526, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_long", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum timeout cap for exponential timeout growth across retries." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_MAX", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1527, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_max", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional HTTP headers to include in all API requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1528, - "kind": 32768, - "kindString": "Parameter", - "name": "headers", - "type": { - "name": "dict[str, str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "str" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create an `ApifyClientAsync` instance with a custom HTTP client.\n\nUse this alternative constructor when you want to provide your own HTTP client implementation\ninstead of the default one. The custom client is responsible for its own configuration\n(retries, timeouts, headers, etc.).\n\n### Usage\n\n```python\nfrom apify_client import ApifyClientAsync\nfrom apify_client.http_clients import HttpClientAsync, HttpResponse\n\nclass MyHttpClient(HttpClientAsync):\n async def call(self, *, method, url, **kwargs) -> HttpResponse:\n ...\n\nclient = ApifyClientAsync.with_custom_http_client(\n token='MY-APIFY-TOKEN',\n http_client=MyHttpClient(),\n)\n```" - } - ] - }, - "decorations": [ - { - "name": "classmethod" - } - ], - "flags": {}, - "groups": [], - "id": 1529, - "module": "_apify_client", - "name": "with_custom_http_client", - "parsedDocstring": { - "text": "Create an `ApifyClientAsync` instance with a custom HTTP client.\n\nUse this alternative constructor when you want to provide your own HTTP client implementation\ninstead of the default one. The custom client is responsible for its own configuration\n(retries, timeouts, headers, etc.).\n\n### Usage\n\n```python\nfrom apify_client import ApifyClientAsync\nfrom apify_client.http_clients import HttpClientAsync, HttpResponse\n\nclass MyHttpClient(HttpClientAsync):\n async def call(self, *, method, url, **kwargs) -> HttpResponse:\n ...\n\nclient = ApifyClientAsync.with_custom_http_client(\n token='MY-APIFY-TOKEN',\n http_client=MyHttpClient(),\n)\n```", - "args": { - "token": "The Apify API token.", - "api_url": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com.", - "api_public_url": "The globally accessible URL of the Apify API server. Defaults to https://api.apify.com.", - "http_client": "A custom HTTP client instance extending `HttpClientAsync`." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 564 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create an `ApifyClientAsync` instance with a custom HTTP client.\n\nUse this alternative constructor when you want to provide your own HTTP client implementation\ninstead of the default one. The custom client is responsible for its own configuration\n(retries, timeouts, headers, etc.).\n\n### Usage\n\n```python\nfrom apify_client import ApifyClientAsync\nfrom apify_client.http_clients import HttpClientAsync, HttpResponse\n\nclass MyHttpClient(HttpClientAsync):\n async def call(self, *, method, url, **kwargs) -> HttpResponse:\n ...\n\nclient = ApifyClientAsync.with_custom_http_client(\n token='MY-APIFY-TOKEN',\n http_client=MyHttpClient(),\n)\n```" - } - ] - }, - "flags": {}, - "id": 1530, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "with_custom_http_client", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Apify API token." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 1531, - "kind": 32768, - "kindString": "Parameter", - "name": "token", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com." - } - ] - }, - "defaultValue": "DEFAULT_API_URL", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1532, - "kind": 32768, - "kindString": "Parameter", - "name": "api_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The globally accessible URL of the Apify API server. Defaults to https://api.apify.com." - } - ] - }, - "defaultValue": "DEFAULT_API_URL", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1533, - "kind": 32768, - "kindString": "Parameter", - "name": "api_public_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A custom HTTP client instance extending `HttpClientAsync`." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 1534, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - } - ], - "type": { - "name": "ApifyClientAsync", - "type": "reference", - "target": "1516" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Apify API token used by the client." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 1535, - "module": "_apify_client", - "name": "token", - "parsedDocstring": { - "text": "The Apify API token used by the client." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 605 - } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP client instance used for API communication.\n\nReturns the custom HTTP client if one was provided via `with_custom_http_client`,\nor the default `ImpitHttpClientAsync` otherwise (lazily created on first access)." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 1536, - "module": "_apify_client", - "name": "http_client", - "parsedDocstring": { - "text": "The HTTP client instance used for API communication.\n\nReturns the custom HTTP client if one was provided via `with_custom_http_client`,\nor the default `ImpitHttpClientAsync` otherwise (lazily created on first access)." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 610 - } - ], - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific Actor.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1537, - "module": "_apify_client", - "name": "actor", - "parsedDocstring": { - "text": "Get the sub-client for a specific Actor.\n", - "args": { - "actor_id": "ID of the Actor to be manipulated." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 640 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific Actor.\n" - } - ] - }, - "flags": {}, - "id": 1538, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "actor", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the Actor to be manipulated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1539, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "ActorClientAsync", - "type": "reference", - "target": "3506" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the Actor collection, allowing to list and create Actors." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1540, - "module": "_apify_client", - "name": "actors", - "parsedDocstring": { - "text": "Get the sub-client for the Actor collection, allowing to list and create Actors." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 648 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the Actor collection, allowing to list and create Actors." - } - ] - }, - "flags": {}, - "id": 1541, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "actors", - "parameters": [], - "type": { - "name": "ActorCollectionClientAsync", - "type": "reference", - "target": "2308" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific Actor build.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1542, - "module": "_apify_client", - "name": "build", - "parsedDocstring": { - "text": "Get the sub-client for a specific Actor build.\n", - "args": { - "build_id": "ID of the Actor build to be manipulated." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 652 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific Actor build.\n" - } - ] - }, - "flags": {}, - "id": 1543, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "build", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the Actor build to be manipulated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1544, - "kind": 32768, - "kindString": "Parameter", - "name": "build_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "BuildClientAsync", - "type": "reference", - "target": "3195" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the build collection, allowing to list builds." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1545, - "module": "_apify_client", - "name": "builds", - "parsedDocstring": { - "text": "Get the sub-client for the build collection, allowing to list builds." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 660 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the build collection, allowing to list builds." - } - ] - }, - "flags": {}, - "id": 1546, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "builds", - "parameters": [], - "type": { - "name": "BuildCollectionClientAsync", - "type": "reference", - "target": "2795" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific Actor run.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1547, - "module": "_apify_client", - "name": "run", - "parsedDocstring": { - "text": "Get the sub-client for a specific Actor run.\n", - "args": { - "run_id": "ID of the Actor run to be manipulated." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 664 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific Actor run.\n" - } - ] - }, - "flags": {}, - "id": 1548, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "run", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the Actor run to be manipulated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1549, - "kind": 32768, - "kindString": "Parameter", - "name": "run_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "RunClientAsync", - "type": "reference", - "target": "3102" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the run collection, allowing to list Actor runs." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1550, - "module": "_apify_client", - "name": "runs", - "parsedDocstring": { - "text": "Get the sub-client for the run collection, allowing to list Actor runs." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 672 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the run collection, allowing to list Actor runs." - } - ] - }, - "flags": {}, - "id": 1551, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "runs", - "parameters": [], - "type": { - "name": "RunCollectionClientAsync", - "type": "reference", - "target": "3939" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific dataset.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1552, - "module": "_apify_client", - "name": "dataset", - "parsedDocstring": { - "text": "Get the sub-client for a specific dataset.\n", - "args": { - "dataset_id": "ID of the dataset to be manipulated." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 676 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific dataset.\n" - } - ] - }, - "flags": {}, - "id": 1553, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "dataset", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the dataset to be manipulated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1554, - "kind": 32768, - "kindString": "Parameter", - "name": "dataset_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "DatasetClientAsync", - "type": "reference", - "target": "2926" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the dataset collection, allowing to list and create datasets." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1555, - "module": "_apify_client", - "name": "datasets", - "parsedDocstring": { - "text": "Get the sub-client for the dataset collection, allowing to list and create datasets." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 684 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the dataset collection, allowing to list and create datasets." - } - ] - }, - "flags": {}, - "id": 1556, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "datasets", - "parameters": [], - "type": { - "name": "DatasetCollectionClientAsync", - "type": "reference", - "target": "3347" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific key-value store.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1557, - "module": "_apify_client", - "name": "key_value_store", - "parsedDocstring": { - "text": "Get the sub-client for a specific key-value store.\n", - "args": { - "key_value_store_id": "ID of the key-value store to be manipulated." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 688 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific key-value store.\n" - } - ] - }, - "flags": {}, - "id": 1558, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "key_value_store", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the key-value store to be manipulated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1559, - "kind": 32768, - "kindString": "Parameter", - "name": "key_value_store_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "KeyValueStoreClientAsync", - "type": "reference", - "target": "3683" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the key-value store collection, allowing to list and create key-value stores." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1560, - "module": "_apify_client", - "name": "key_value_stores", - "parsedDocstring": { - "text": "Get the sub-client for the key-value store collection, allowing to list and create key-value stores." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 696 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the key-value store collection, allowing to list and create key-value stores." - } - ] - }, - "flags": {}, - "id": 1561, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "key_value_stores", - "parameters": [], - "type": { - "name": "KeyValueStoreCollectionClientAsync", - "type": "reference", - "target": "2398" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific request queue.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1562, - "module": "_apify_client", - "name": "request_queue", - "parsedDocstring": { - "text": "Get the sub-client for a specific request queue.\n", - "args": { - "request_queue_id": "ID of the request queue to be manipulated.", - "client_key": "A unique identifier of the client accessing the request queue." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 700 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific request queue.\n" - } - ] - }, - "flags": {}, - "id": 1563, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "request_queue", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the request queue to be manipulated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1564, - "kind": 32768, - "kindString": "Parameter", - "name": "request_queue_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier of the client accessing the request queue." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1565, - "kind": 32768, - "kindString": "Parameter", - "name": "client_key", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "RequestQueueClientAsync", - "type": "reference", - "target": "2078" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the request queue collection, allowing to list and create request queues." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1566, - "module": "_apify_client", - "name": "request_queues", - "parsedDocstring": { - "text": "Get the sub-client for the request queue collection, allowing to list and create request queues." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 709 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the request queue collection, allowing to list and create request queues." - } - ] - }, - "flags": {}, - "id": 1567, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "request_queues", - "parameters": [], - "type": { - "name": "RequestQueueCollectionClientAsync", - "type": "reference", - "target": "2505" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific webhook.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1568, - "module": "_apify_client", - "name": "webhook", - "parsedDocstring": { - "text": "Get the sub-client for a specific webhook.\n", - "args": { - "webhook_id": "ID of the webhook to be manipulated." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 713 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific webhook.\n" - } - ] - }, - "flags": {}, - "id": 1569, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "webhook", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the webhook to be manipulated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1570, - "kind": 32768, - "kindString": "Parameter", - "name": "webhook_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "WebhookClientAsync", - "type": "reference", - "target": "3886" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the webhook collection, allowing to list and create webhooks." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1571, - "module": "_apify_client", - "name": "webhooks", - "parsedDocstring": { - "text": "Get the sub-client for the webhook collection, allowing to list and create webhooks." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 721 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the webhook collection, allowing to list and create webhooks." - } - ] - }, - "flags": {}, - "id": 1572, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "webhooks", - "parameters": [], - "type": { - "name": "WebhookCollectionClientAsync", - "type": "reference", - "target": "3825" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific webhook dispatch.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1573, - "module": "_apify_client", - "name": "webhook_dispatch", - "parsedDocstring": { - "text": "Get the sub-client for a specific webhook dispatch.\n", - "args": { - "webhook_dispatch_id": "ID of the webhook dispatch to access." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 725 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific webhook dispatch.\n" - } - ] - }, - "flags": {}, - "id": 1574, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "webhook_dispatch", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the webhook dispatch to access." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1575, - "kind": 32768, - "kindString": "Parameter", - "name": "webhook_dispatch_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "WebhookDispatchClientAsync", - "type": "reference", - "target": "2363" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the webhook dispatch collection, allowing to list webhook dispatches." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1576, - "module": "_apify_client", - "name": "webhook_dispatches", - "parsedDocstring": { - "text": "Get the sub-client for the webhook dispatch collection, allowing to list webhook dispatches." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 733 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the webhook dispatch collection, allowing to list webhook dispatches." - } - ] - }, - "flags": {}, - "id": 1577, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "webhook_dispatches", - "parameters": [], - "type": { - "name": "WebhookDispatchCollectionClientAsync", - "type": "reference", - "target": "2245" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific schedule.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1578, - "module": "_apify_client", - "name": "schedule", - "parsedDocstring": { - "text": "Get the sub-client for a specific schedule.\n", - "args": { - "schedule_id": "ID of the schedule to be manipulated." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 737 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific schedule.\n" - } - ] - }, - "flags": {}, - "id": 1579, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "schedule", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the schedule to be manipulated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1580, - "kind": 32768, - "kindString": "Parameter", - "name": "schedule_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "ScheduleClientAsync", - "type": "reference", - "target": "1930" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the schedule collection, allowing to list and create schedules." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1581, - "module": "_apify_client", - "name": "schedules", - "parsedDocstring": { - "text": "Get the sub-client for the schedule collection, allowing to list and create schedules." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 745 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the schedule collection, allowing to list and create schedules." - } - ] - }, - "flags": {}, - "id": 1582, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "schedules", - "parameters": [], - "type": { - "name": "ScheduleCollectionClientAsync", - "type": "reference", - "target": "3247" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for retrieving logs of an Actor build or run.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1583, - "module": "_apify_client", - "name": "log", - "parsedDocstring": { - "text": "Get the sub-client for retrieving logs of an Actor build or run.\n", - "args": { - "build_or_run_id": "ID of the Actor build or run for which to access the log." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 749 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for retrieving logs of an Actor build or run.\n" - } - ] - }, - "flags": {}, - "id": 1584, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "log", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the Actor build or run for which to access the log." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1585, - "kind": 32768, - "kindString": "Parameter", - "name": "build_or_run_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "LogClientAsync", - "type": "reference", - "target": "2177" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific Actor task.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1586, - "module": "_apify_client", - "name": "task", - "parsedDocstring": { - "text": "Get the sub-client for a specific Actor task.\n", - "args": { - "task_id": "ID of the task to be manipulated." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 757 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for a specific Actor task.\n" - } - ] - }, - "flags": {}, - "id": 1587, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "task", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the task to be manipulated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1588, - "kind": 32768, - "kindString": "Parameter", - "name": "task_id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "TaskClientAsync", - "type": "reference", - "target": "2713" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the task collection, allowing to list and create Actor tasks." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1589, - "module": "_apify_client", - "name": "tasks", - "parsedDocstring": { - "text": "Get the sub-client for the task collection, allowing to list and create Actor tasks." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 765 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the task collection, allowing to list and create Actor tasks." - } - ] - }, - "flags": {}, - "id": 1590, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "tasks", - "parameters": [], - "type": { - "name": "TaskCollectionClientAsync", - "type": "reference", - "target": "2564" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for querying user data.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1591, - "module": "_apify_client", - "name": "user", - "parsedDocstring": { - "text": "Get the sub-client for querying user data.\n", - "args": { - "user_id": "ID of user to be queried. If None, queries the user belonging to the token supplied to the client." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 769 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for querying user data.\n" - } - ] - }, - "flags": {}, - "id": 1592, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "user", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of user to be queried. If None, queries the user belonging to the token supplied to the client." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 1593, - "kind": 32768, - "kindString": "Parameter", - "name": "user_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "UserClientAsync", - "type": "reference", - "target": "1976" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the Apify Store, allowing to list Actors published in the store." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1594, - "module": "_apify_client", - "name": "store", - "parsedDocstring": { - "text": "Get the sub-client for the Apify Store, allowing to list Actors published in the store." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 777 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the sub-client for the Apify Store, allowing to list Actors published in the store." - } - ] - }, - "flags": {}, - "id": 1595, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "store", - "parameters": [], - "type": { - "name": "StoreCollectionClientAsync", - "type": "reference", - "target": "2623" - } - } - ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Asynchronous client for the Apify API.\n\nThis is the main entry point for interacting with the Apify platform using async/await. It provides\nmethods to access resource-specific sub-clients for managing Actors, runs, datasets, key-value stores,\nrequest queues, schedules, webhooks, and more.\n\nThe client automatically handles retries with exponential backoff for failed or rate-limited requests.\n\n### Usage\n\n```python\nimport asyncio\n\nfrom apify_client import ApifyClientAsync\n\n\nasync def main() -> None:\n client = ApifyClientAsync(token='MY-APIFY-TOKEN')\n\n # Start an Actor and wait for it to finish.\n actor_client = client.actor('apify/python-example')\n run = await actor_client.call(run_input={'first_number': 1, 'second_number': 2})\n\n # Fetch results from the run's default dataset.\n if run is not None:\n dataset_client = client.dataset(run.default_dataset_id)\n items = (await dataset_client.list_items()).items\n for item in items:\n print(item)\n\n\nasyncio.run(main())\n```" - } - ] - }, - "decorations": [ - { - "args": "('Apify API clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1517, - 1537, - 1540, - 1542, - 1545, - 1552, - 1555, - 1557, - 1560, - 1583, - 1562, - 1566, - 1547, - 1550, - 1578, - 1581, - 1594, - 1586, - 1589, - 1591, - 1568, - 1573, - 1576, - 1571, - 1529 - ], - "title": "Methods" - }, - { - "children": [ - 1536, - 1535 - ], - "title": "Properties" - } - ], - "id": 1516, - "module": "_apify_client", - "name": "ApifyClientAsync", - "parsedDocstring": { - "text": "Asynchronous client for the Apify API.\n\nThis is the main entry point for interacting with the Apify platform using async/await. It provides\nmethods to access resource-specific sub-clients for managing Actors, runs, datasets, key-value stores,\nrequest queues, schedules, webhooks, and more.\n\nThe client automatically handles retries with exponential backoff for failed or rate-limited requests.\n\n### Usage\n\n```python\nimport asyncio\n\nfrom apify_client import ApifyClientAsync\n\n\nasync def main() -> None:\n client = ApifyClientAsync(token='MY-APIFY-TOKEN')\n\n # Start an Actor and wait for it to finish.\n actor_client = client.actor('apify/python-example')\n run = await actor_client.call(run_input={'first_number': 1, 'second_number': 2})\n\n # Fetch results from the run's default dataset.\n if run is not None:\n dataset_client = client.dataset(run.default_dataset_id)\n items = (await dataset_client.list_items()).items\n for item in items:\n print(item)\n\n\nasyncio.run(main())\n```" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_apify_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 430 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1596, - "module": "__init__", - "name": "__version__", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/__init__.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 5 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the logger used throughout the library." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1597, - "module": "_logging", - "name": "logger_name", - "parsedDocstring": { - "text": "Name of the logger used throughout the library." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_logging.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 19 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Logger used throughout the library." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1598, - "module": "_logging", - "name": "logger", - "parsedDocstring": { - "text": "Logger used throughout the library." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_logging.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 22 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1600, - "module": "_logging", - "name": "attempt", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_logging.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 29 - } - ], - "type": { - "name": "ContextVar", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1601, - "module": "_logging", - "name": "client_method", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_logging.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 30 - } - ], - "type": { - "name": "ContextVar", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1602, - "module": "_logging", - "name": "method", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_logging.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 31 - } - ], - "type": { - "name": "ContextVar", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1603, - "module": "_logging", - "name": "resource_id", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_logging.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 32 - } - ], - "type": { - "name": "ContextVar", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - ] - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1604, - "module": "_logging", - "name": "url", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_logging.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 33 - } - ], - "type": { - "name": "ContextVar", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request context details for logging (attempt, client method, HTTP method, resource ID, URL)." - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 1600, - 1601, - 1602, - 1603, - 1604 - ], - "title": "Properties" - } - ], - "id": 1599, - "module": "_logging", - "name": "LogContext", - "parsedDocstring": { - "text": "Request context details for logging (attempt, client method, HTTP method, resource ID, URL)." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_logging.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 26 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1605, - "module": "_logging", - "name": "log_context", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_logging.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 36 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wrap all public methods in the class with logging context injection." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1607, - "module": "_logging", - "name": "__new__", - "parsedDocstring": { - "text": "Wrap all public methods in the class with logging context injection." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_logging.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 48 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wrap all public methods in the class with logging context injection." - } - ] - }, - "flags": {}, - "id": 1608, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__new__", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1609, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1610, - "kind": 32768, - "kindString": "Parameter", - "name": "bases", - "type": { - "name": "tuple", - "type": "reference" - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1611, - "kind": 32768, - "kindString": "Parameter", - "name": "attrs", - "type": { - "name": "dict", - "type": "reference" - } - } - ], - "type": { - "name": "WithLogDetailsClient", - "type": "reference", - "target": "1606" - } - } - ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Metaclass that wraps public methods to inject client details into log context." - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 1607 - ], - "title": "Methods" - } - ], - "id": 1606, - "module": "_logging", - "name": "WithLogDetailsClient", - "parsedDocstring": { - "text": "Metaclass that wraps public methods to inject client details into log context." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_logging.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 45 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Format log by prepending colored logger name.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1613, - "module": "_logging", - "name": "format", - "parsedDocstring": { - "text": "Format log by prepending colored logger name.\n", - "args": { - "record": "The log record to format.\n" - }, - "returns": "Formatted log message with colored logger name prefix." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_logging.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 60 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Formatted log message with colored logger name prefix." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Format log by prepending colored logger name.\n" - } - ] - }, - "flags": {}, - "id": 1614, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "format", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The log record to format.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1615, - "kind": 32768, - "kindString": "Parameter", - "name": "record", - "type": { - "name": "logging.LogRecord", - "type": "reference" - } - } - ], - "type": { - "name": "str", - "type": "reference" - } - } - ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log formatter that prepends colored logger name to messages." - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 1613 - ], - "title": "Methods" - } - ], - "id": 1612, - "module": "_logging", - "name": "RedirectLogFormatter", - "parsedDocstring": { - "text": "Log formatter that prepends colored logger name to messages." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_logging.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 57 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a logger for redirecting logs from another Actor.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1616, - "module": "_logging", - "name": "create_redirect_logger", - "parsedDocstring": { - "text": "Create a logger for redirecting logs from another Actor.\n", - "args": { - "name": "Logger name. Use dot notation for hierarchy (e.g., \"apify.xyz\" creates \"xyz\" under \"apify\").\n" - }, - "returns": "Configured logger with RedirectLogFormatter." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_logging.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 74 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Configured logger with RedirectLogFormatter." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create a logger for redirecting logs from another Actor.\n" - } - ] - }, - "flags": {}, - "id": 1617, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "create_redirect_logger", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Logger name. Use dot notation for hierarchy (e.g., \"apify.xyz\" creates \"xyz\" under \"apify\").\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1618, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "logging.Logger", - "type": "reference" - } - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Add log context variables to the record." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1620, - "module": "_logging", - "name": "filter", - "parsedDocstring": { - "text": "Add log context variables to the record." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_logging.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 102 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Add log context variables to the record." - } - ] - }, - "flags": {}, - "id": 1621, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "filter", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1622, - "kind": 32768, - "kindString": "Parameter", - "name": "record", - "type": { - "name": "logging.LogRecord", - "type": "reference" - } - } - ], - "type": { - "name": "bool", - "type": "reference" - } - } - ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter that injects current log context into all log records." - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 1620 - ], - "title": "Methods" - } - ], - "id": 1619, - "module": "_logging", - "name": "_ContextInjectingFilter", - "parsedDocstring": { - "text": "Filter that injects current log context into all log records." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_logging.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 99 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1623, - "module": "_utils", - "name": "T", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_utils.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 27 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Convert timedelta to seconds.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1624, - "module": "_utils", - "name": "to_seconds", - "parsedDocstring": { - "text": "Convert timedelta to seconds.\n", - "args": { - "td": "The timedelta to convert, or None.", - "as_int": "If True, round and return as int. Defaults to False.\n" - }, - "returns": "The total seconds as a float (or int if as_int=True), or None if input is None." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_utils.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 43 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The total seconds as a float (or int if as_int=True), or None if input is None." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Convert timedelta to seconds.\n" - } - ] - }, - "flags": {}, - "id": 1625, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "to_seconds", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The timedelta to convert, or None." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1626, - "kind": 32768, - "kindString": "Parameter", - "name": "td", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, round and return as int. Defaults to False.\n" - } - ] - }, - "defaultValue": "False", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1627, - "kind": 32768, - "kindString": "Parameter", - "name": "as_int", - "type": { - "name": "bool", - "type": "reference" - } - } - ], - "type": { - "name": "float | int | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "float" - }, - { - "type": "reference", - "name": "int" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Suppress 404 Not Found errors and re-raise all other API errors.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1628, - "module": "_utils", - "name": "catch_not_found_or_throw", - "parsedDocstring": { - "text": "Suppress 404 Not Found errors and re-raise all other API errors.\n", - "args": { - "exc": "The API error to check.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_utils.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 59 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Suppress 404 Not Found errors and re-raise all other API errors.\n" - } - ] - }, - "flags": {}, - "id": 1629, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "catch_not_found_or_throw", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The API error to check.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1630, - "kind": 32768, - "kindString": "Parameter", - "name": "exc", - "type": { - "name": "ApifyApiError", - "type": "reference", - "target": "17" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Like `catch_not_found_or_throw`, but only suppress 404s when the client targets a specific resource by ID.\n\nFor chained clients without a `resource_id` (e.g. `run.dataset()`, `run.log()`), a 404 could mean either the\nparent or the default sub-resource is missing — the API body cannot disambiguate — so the error propagates\nrather than being swallowed." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1631, - "module": "_utils", - "name": "catch_not_found_for_resource_or_throw", - "parsedDocstring": { - "text": "Like `catch_not_found_or_throw`, but only suppress 404s when the client targets a specific resource by ID.\n\nFor chained clients without a `resource_id` (e.g. `run.dataset()`, `run.log()`), a 404 could mean either the\nparent or the default sub-resource is missing — the API body cannot disambiguate — so the error propagates\nrather than being swallowed." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_utils.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Like `catch_not_found_or_throw`, but only suppress 404s when the client targets a specific resource by ID.\n\nFor chained clients without a `resource_id` (e.g. `run.dataset()`, `run.log()`), a 404 could mean either the\nparent or the default sub-resource is missing — the API body cannot disambiguate — so the error propagates\nrather than being swallowed." - } - ] - }, - "flags": {}, - "id": 1632, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "catch_not_found_for_resource_or_throw", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1633, - "kind": 32768, - "kindString": "Parameter", - "name": "exc", - "type": { - "name": "ApifyApiError", - "type": "reference", - "target": "17" - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1634, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Encode a value for storage in a key-value store record.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1635, - "module": "_utils", - "name": "encode_key_value_store_record_value", - "parsedDocstring": { - "text": "Encode a value for storage in a key-value store record.\n", - "args": { - "value": "The value to encode (can be dict, str, bytes, or file-like object).", - "content_type": "The content type; if None, it's inferred from the value type.\n" - }, - "returns": "A tuple of (encoded_value, content_type)." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_utils.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 84 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A tuple of (encoded_value, content_type)." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Encode a value for storage in a key-value store record.\n" - } - ] - }, - "flags": {}, - "id": 1636, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "encode_key_value_store_record_value", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to encode (can be dict, str, bytes, or file-like object)." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1637, - "kind": 32768, - "kindString": "Parameter", - "name": "value", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type; if None, it's inferred from the value type.\n" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1638, - "kind": 32768, - "kindString": "Parameter", - "name": "content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "tuple", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Any" - }, - { - "type": "reference", - "name": "str" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Check if the given error is retryable.\n\nAll `impit.HTTPError` subclasses are considered retryable because they represent transport-level failures\n(network issues, timeouts, protocol errors, body decoding errors) that are typically transient. HTTP status\ncode errors are handled separately in `_make_request` based on the response status code, not here." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1639, - "module": "_utils", - "name": "is_retryable_error", - "parsedDocstring": { - "text": "Check if the given error is retryable.\n\nAll `impit.HTTPError` subclasses are considered retryable because they represent transport-level failures\n(network issues, timeouts, protocol errors, body decoding errors) that are typically transient. HTTP status\ncode errors are handled separately in `_make_request` based on the response status code, not here." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_utils.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 118 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Check if the given error is retryable.\n\nAll `impit.HTTPError` subclasses are considered retryable because they represent transport-level failures\n(network issues, timeouts, protocol errors, body decoding errors) that are typically transient. HTTP status\ncode errors are handled separately in `_make_request` based on the response status code, not here." - } - ] - }, - "flags": {}, - "id": 1640, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "is_retryable_error", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1641, - "kind": 32768, - "kindString": "Parameter", - "name": "exc", - "type": { - "name": "Exception", - "type": "reference" - } - } - ], - "type": { - "name": "bool", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Convert a resource ID to URL-safe format by replacing forward slashes with tildes.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1642, - "module": "_utils", - "name": "to_safe_id", - "parsedDocstring": { - "text": "Convert a resource ID to URL-safe format by replacing forward slashes with tildes.\n", - "args": { - "id": "The resource identifier in format `resource_id` or `username/resource_id`.\n" - }, - "returns": "The resource identifier with `/` characters replaced by `~`." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_utils.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 134 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The resource identifier with `/` characters replaced by `~`." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Convert a resource ID to URL-safe format by replacing forward slashes with tildes.\n" - } - ] - }, - "flags": {}, - "id": 1643, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "to_safe_id", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The resource identifier in format `resource_id` or `username/resource_id`.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1644, - "kind": 32768, - "kindString": "Parameter", - "name": "id", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "str", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parse the API response as a dictionary and validate its type.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1645, - "module": "_utils", - "name": "response_to_dict", - "parsedDocstring": { - "text": "Parse the API response as a dictionary and validate its type.\n", - "args": { - "response": "The HTTP response object from the API.\n" - }, - "returns": "The parsed response as a dictionary." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_utils.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 146 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The parsed response as a dictionary." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Parse the API response as a dictionary and validate its type.\n" - } - ] - }, - "flags": {}, - "id": 1646, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "response_to_dict", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP response object from the API.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1647, - "kind": 32768, - "kindString": "Parameter", - "name": "response", - "type": { - "name": "HttpResponse", - "type": "reference", - "target": "1805" - } - } - ], - "type": { - "name": "dict", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parse the API response as a list and validate its type.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1648, - "module": "_utils", - "name": "response_to_list", - "parsedDocstring": { - "text": "Parse the API response as a list and validate its type.\n", - "args": { - "response": "The HTTP response object from the API.\n" - }, - "returns": "The parsed response as a list." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_utils.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 166 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The parsed response as a list." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Parse the API response as a list and validate its type.\n" - } - ] - }, - "flags": {}, - "id": 1649, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "response_to_list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HTTP response object from the API.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1650, - "kind": 32768, - "kindString": "Parameter", - "name": "response", - "type": { - "name": "HttpResponse", - "type": "reference", - "target": "1805" - } - } - ], - "type": { - "name": "list", - "type": "reference", - "target": "2199" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Encode an integer to a base62 string.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1651, - "module": "_utils", - "name": "encode_base62", - "parsedDocstring": { - "text": "Encode an integer to a base62 string.\n", - "args": { - "num": "The number to encode.\n" - }, - "returns": "The base62-encoded string." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_utils.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 189 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The base62-encoded string." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Encode an integer to a base62 string.\n" - } - ] - }, - "flags": {}, - "id": 1652, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "encode_base62", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number to encode.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1653, - "kind": 32768, - "kindString": "Parameter", - "name": "num", - "type": { - "name": "int", - "type": "reference" - } - } - ], - "type": { - "name": "str", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generate an HMAC-SHA256 signature and encode it using base62.\n\nThe HMAC signature is truncated to 30 characters and then encoded in base62 to reduce the signature length.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1654, - "module": "_utils", - "name": "create_hmac_signature", - "parsedDocstring": { - "text": "Generate an HMAC-SHA256 signature and encode it using base62.\n\nThe HMAC signature is truncated to 30 characters and then encoded in base62 to reduce the signature length.\n", - "args": { - "secret_key": "The secret key used for signing.", - "message": "The message to be signed.\n" - }, - "returns": "The base62-encoded signature." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_utils.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 211 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The base62-encoded signature." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Generate an HMAC-SHA256 signature and encode it using base62.\n\nThe HMAC signature is truncated to 30 characters and then encoded in base62 to reduce the signature length.\n" - } - ] - }, - "flags": {}, - "id": 1655, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "create_hmac_signature", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The secret key used for signing." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1656, - "kind": 32768, - "kindString": "Parameter", - "name": "secret_key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The message to be signed.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1657, - "kind": 32768, - "kindString": "Parameter", - "name": "message", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "str", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a secure signature for a storage resource like a dataset or key-value store.\n\nThis signature is used to generate a signed URL for authenticated access, which can be expiring or permanent.\nThe signature is created using HMAC with the provided secret key and includes the resource ID, expiration time,\nand version.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1658, - "module": "_utils", - "name": "create_storage_content_signature", - "parsedDocstring": { - "text": "Create a secure signature for a storage resource like a dataset or key-value store.\n\nThis signature is used to generate a signed URL for authenticated access, which can be expiring or permanent.\nThe signature is created using HMAC with the provided secret key and includes the resource ID, expiration time,\nand version.\n", - "args": { - "resource_id": "The unique identifier of the storage resource.", - "url_signing_secret_key": "The secret key for signing the URL.", - "expires_in": "Optional expiration duration; if None, the signature never expires.", - "version": "The signature version number (default: 0).\n" - }, - "returns": "The base64url-encoded signature string." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_utils.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 230 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The base64url-encoded signature string." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create a secure signature for a storage resource like a dataset or key-value store.\n\nThis signature is used to generate a signed URL for authenticated access, which can be expiring or permanent.\nThe signature is created using HMAC with the provided secret key and includes the resource ID, expiration time,\nand version.\n" - } - ] - }, - "flags": {}, - "id": 1659, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "create_storage_content_signature", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique identifier of the storage resource." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1660, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The secret key for signing the URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1661, - "kind": 32768, - "kindString": "Parameter", - "name": "url_signing_secret_key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional expiration duration; if None, the signature never expires." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1662, - "kind": 32768, - "kindString": "Parameter", - "name": "expires_in", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The signature version number (default: 0).\n" - } - ] - }, - "defaultValue": "0", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1663, - "kind": 32768, - "kindString": "Parameter", - "name": "version", - "type": { - "name": "int", - "type": "reference" - } - } - ], - "type": { - "name": "str", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Warn if custom headers override important default headers." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1664, - "module": "_utils", - "name": "check_custom_headers", - "parsedDocstring": { - "text": "Warn if custom headers override important default headers." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_utils.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 261 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Warn if custom headers override important default headers." - } - ] - }, - "flags": {}, - "id": 1665, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "check_custom_headers", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1666, - "kind": 32768, - "kindString": "Parameter", - "name": "class_name", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1667, - "kind": 32768, - "kindString": "Parameter", - "name": "headers", - "type": { - "name": "dict", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "str" - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Encode a list of ad-hoc webhooks to a base64 string for the `webhooks` query parameter.\n\nReturns `None` for `None` or an empty list, so the query parameter is omitted.\n\nSee `WebhooksList` for the accepted shapes. `WebhookRepresentation` instances are used as-is; `WebhookCreate`\ninstances are projected onto the `WebhookRepresentation` fields, dropping persistent-only fields like `condition`.\nDict shapes are validated into `WebhookRepresentation` and only fields it declares are kept." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1668, - "module": "_utils", - "name": "encode_webhooks_to_base64", - "parsedDocstring": { - "text": "Encode a list of ad-hoc webhooks to a base64 string for the `webhooks` query parameter.\n\nReturns `None` for `None` or an empty list, so the query parameter is omitted.\n\nSee `WebhooksList` for the accepted shapes. `WebhookRepresentation` instances are used as-is; `WebhookCreate`\ninstances are projected onto the `WebhookRepresentation` fields, dropping persistent-only fields like `condition`.\nDict shapes are validated into `WebhookRepresentation` and only fields it declares are kept." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_utils.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 286 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Encode a list of ad-hoc webhooks to a base64 string for the `webhooks` query parameter.\n\nReturns `None` for `None` or an empty list, so the query parameter is omitted.\n\nSee `WebhooksList` for the accepted shapes. `WebhookRepresentation` instances are used as-is; `WebhookCreate`\ninstances are projected onto the `WebhookRepresentation` fields, dropping persistent-only fields like `condition`.\nDict shapes are validated into `WebhookRepresentation` and only fields it declares are kept." - } - ] - }, - "flags": {}, - "id": 1669, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "encode_webhooks_to_base64", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1670, - "kind": 32768, - "kindString": "Parameter", - "name": "webhooks", - "type": { - "name": "WebhooksList | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "WebhooksList", - "target": "14" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1672, - "module": "_status_message_watcher", - "name": "__init__", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_status_message_watcher.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 31 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "flags": {}, - "id": 1673, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 1674, - "kind": 32768, - "kindString": "Parameter", - "name": "to_logger", - "type": { - "name": "logging.Logger", - "type": "reference" - } - }, - { - "defaultValue": "timedelta(seconds=5)", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1675, - "kind": 32768, - "kindString": "Parameter", - "name": "check_period", - "type": { - "name": "timedelta", - "type": "reference" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base class for polling and logging Actor run status messages." - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 1672 - ], - "title": "Methods" - } - ], - "id": 1671, - "module": "_status_message_watcher", - "name": "StatusMessageWatcherBase", - "parsedDocstring": { - "text": "Base class for polling and logging Actor run status messages." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_status_message_watcher.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 22 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "StatusMessageWatcherAsync", - "target": "1676", - "type": "reference" - }, - { - "name": "StatusMessageWatcher", - "target": "1693", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize `StatusMessageWatcherAsync`.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1677, - "module": "_status_message_watcher", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize `StatusMessageWatcherAsync`.\n", - "args": { - "run_client": "The run client used to poll the Actor run status and status message.", - "to_logger": "The logger to which the status messages will be forwarded.", - "check_period": "How often to poll the status message." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_status_message_watcher.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize `StatusMessageWatcherAsync`.\n" - } - ] - }, - "flags": {}, - "id": 1678, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The run client used to poll the Actor run status and status message." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 1679, - "kind": 32768, - "kindString": "Parameter", - "name": "run_client", - "type": { - "name": "RunClientAsync", - "type": "reference", - "target": "3102" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The logger to which the status messages will be forwarded." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 1680, - "kind": 32768, - "kindString": "Parameter", - "name": "to_logger", - "type": { - "name": "logging.Logger", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How often to poll the status message." - } - ] - }, - "defaultValue": "timedelta(seconds=1)", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1681, - "kind": 32768, - "kindString": "Parameter", - "name": "check_period", - "type": { - "name": "timedelta", - "type": "reference" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "StatusMessageWatcherBase.__init__", - "target": 1672, - "type": "reference" - } - } - ], - "overwrites": { - "name": "StatusMessageWatcherBase.__init__", - "target": 1672, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start the polling task.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1682, - "module": "_status_message_watcher", - "name": "start", - "parsedDocstring": { - "text": "Start the polling task.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_status_message_watcher.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 86 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start the polling task.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." - } - ] - }, - "flags": {}, - "id": 1683, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "start", - "parameters": [], - "type": { - "name": "Task", - "type": "reference", - "target": "1197" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stop the logging task." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1684, - "module": "_status_message_watcher", - "name": "stop", - "parsedDocstring": { - "text": "Stop the logging task." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_status_message_watcher.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 96 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stop the logging task." - } - ] - }, - "flags": {}, - "id": 1685, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "stop", - "parameters": [], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start the logging task within the context. Exiting the context will cancel the logging task." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1686, - "module": "_status_message_watcher", - "name": "__aenter__", - "parsedDocstring": { - "text": "Start the logging task within the context. Exiting the context will cancel the logging task." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_status_message_watcher.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 109 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start the logging task within the context. Exiting the context will cancel the logging task." - } - ] - }, - "flags": {}, - "id": 1687, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "__aenter__", - "parameters": [], - "type": { - "name": "Self", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Cancel the logging task." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1688, - "module": "_status_message_watcher", - "name": "__aexit__", - "parsedDocstring": { - "text": "Cancel the logging task." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_status_message_watcher.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 114 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Cancel the logging task." - } - ] - }, - "flags": {}, - "id": 1689, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "__aexit__", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1690, - "kind": 32768, - "kindString": "Parameter", - "name": "exc_type", - "type": { - "name": "type[BaseException] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "type", - "typeArguments": [ - { - "type": "reference", - "name": "BaseException" - } - ], - "target": "474" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1691, - "kind": 32768, - "kindString": "Parameter", - "name": "exc_val", - "type": { - "name": "BaseException | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "BaseException" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1692, - "kind": 32768, - "kindString": "Parameter", - "name": "exc_tb", - "type": { - "name": "TracebackType | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "TracebackType" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Polls and logs Actor run status messages in an asyncio task.\n\nThe status message and status of the Actor run are polled at a fixed interval and forwarded to the provided logger\nwhenever they change. There is no guarantee that every intermediate status message will be captured, especially\nwhen messages change rapidly.\n\nCan be used as an async context manager, which automatically starts and cancels the polling task. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClientAsync.get_status_message_watcher`." - } - ] - }, - "decorations": [ - { - "args": "('Other')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1686, - 1688, - 1677, - 1682, - 1684 - ], - "title": "Methods" - } - ], - "id": 1676, - "module": "_status_message_watcher", - "name": "StatusMessageWatcherAsync", - "parsedDocstring": { - "text": "Polls and logs Actor run status messages in an asyncio task.\n\nThe status message and status of the Actor run are polled at a fixed interval and forwarded to the provided logger\nwhenever they change. There is no guarantee that every intermediate status message will be captured, especially\nwhen messages change rapidly.\n\nCan be used as an async context manager, which automatically starts and cancels the polling task. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClientAsync.get_status_message_watcher`." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_status_message_watcher.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 61 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "StatusMessageWatcherBase", - "target": "1671", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize `StatusMessageWatcher`.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1694, - "module": "_status_message_watcher", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize `StatusMessageWatcher`.\n", - "args": { - "run_client": "The run client used to poll the Actor run status and status message.", - "to_logger": "The logger to which the status messages will be forwarded.", - "check_period": "How often to poll the status message." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_status_message_watcher.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 142 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize `StatusMessageWatcher`.\n" - } - ] - }, - "flags": {}, - "id": 1695, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The run client used to poll the Actor run status and status message." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 1696, - "kind": 32768, - "kindString": "Parameter", - "name": "run_client", - "type": { - "name": "RunClient", - "type": "reference", - "target": "3033" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The logger to which the status messages will be forwarded." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 1697, - "kind": 32768, - "kindString": "Parameter", - "name": "to_logger", - "type": { - "name": "logging.Logger", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How often to poll the status message." - } - ] - }, - "defaultValue": "timedelta(seconds=1)", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1698, - "kind": 32768, - "kindString": "Parameter", - "name": "check_period", - "type": { - "name": "timedelta", - "type": "reference" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "StatusMessageWatcherBase.__init__", - "target": 1672, - "type": "reference" - } - } - ], - "overwrites": { - "name": "StatusMessageWatcherBase.__init__", - "target": 1672, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start the polling thread.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1699, - "module": "_status_message_watcher", - "name": "start", - "parsedDocstring": { - "text": "Start the polling thread.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_status_message_watcher.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 157 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start the polling thread.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." - } - ] - }, - "flags": {}, - "id": 1700, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "start", - "parameters": [], - "type": { - "name": "Thread", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signal the logging thread to stop logging and wait for it to finish." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1701, - "module": "_status_message_watcher", - "name": "stop", - "parsedDocstring": { - "text": "Signal the logging thread to stop logging and wait for it to finish." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_status_message_watcher.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 169 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signal the logging thread to stop logging and wait for it to finish." - } - ] - }, - "flags": {}, - "id": 1702, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "stop", - "parameters": [], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start the logging thread within the context. Exiting the context will stop the logging thread." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1703, - "module": "_status_message_watcher", - "name": "__enter__", - "parsedDocstring": { - "text": "Start the logging thread within the context. Exiting the context will stop the logging thread." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_status_message_watcher.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 178 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start the logging thread within the context. Exiting the context will stop the logging thread." - } - ] - }, - "flags": {}, - "id": 1704, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__enter__", - "parameters": [], - "type": { - "name": "Self", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stop the logging thread." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1705, - "module": "_status_message_watcher", - "name": "__exit__", - "parsedDocstring": { - "text": "Stop the logging thread." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_status_message_watcher.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 183 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stop the logging thread." - } - ] - }, - "flags": {}, - "id": 1706, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__exit__", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1707, - "kind": 32768, - "kindString": "Parameter", - "name": "exc_type", - "type": { - "name": "type[BaseException] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "type", - "typeArguments": [ - { - "type": "reference", - "name": "BaseException" - } - ], - "target": "474" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1708, - "kind": 32768, - "kindString": "Parameter", - "name": "exc_val", - "type": { - "name": "BaseException | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "BaseException" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1709, - "kind": 32768, - "kindString": "Parameter", - "name": "exc_tb", - "type": { - "name": "TracebackType | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "TracebackType" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Polls and logs Actor run status messages in a background thread.\n\nThe status message and status of the Actor run are polled at a fixed interval and forwarded to the provided logger\nwhenever they change. There is no guarantee that every intermediate status message will be captured, especially\nwhen messages change rapidly.\n\nCan be used as a context manager, which automatically starts and stops the polling thread. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClient.get_status_message_watcher`." - } - ] - }, - "decorations": [ - { - "args": "('Other')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1703, - 1705, - 1694, - 1699, - 1701 - ], - "title": "Methods" - } - ], - "id": 1693, - "module": "_status_message_watcher", - "name": "StatusMessageWatcher", - "parsedDocstring": { - "text": "Polls and logs Actor run status messages in a background thread.\n\nThe status message and status of the Actor run are polled at a fixed interval and forwarded to the provided logger\nwhenever they change. There is no guarantee that every intermediate status message will be captured, especially\nwhen messages change rapidly.\n\nCan be used as a context manager, which automatically starts and stops the polling thread. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClient.get_status_message_watcher`." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_status_message_watcher.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 131 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "StatusMessageWatcherBase", - "target": "1671", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1711, - "module": "_client_registry", - "name": "actor_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 73 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ActorClient", - "target": "3404" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1712, - "module": "_client_registry", - "name": "actor_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 74 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ActorCollectionClient", - "target": "2262" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1713, - "module": "_client_registry", - "name": "actor_env_var_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 75 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ActorEnvVarClient", - "target": "3758" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1714, - "module": "_client_registry", - "name": "actor_env_var_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 76 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ActorEnvVarCollectionClient", - "target": "2194" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1715, - "module": "_client_registry", - "name": "actor_version_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 77 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ActorVersionClient", - "target": "2424" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1716, - "module": "_client_registry", - "name": "actor_version_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 78 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ActorVersionCollectionClient", - "target": "3275" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1717, - "module": "_client_registry", - "name": "build_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 79 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "BuildClient", - "target": "3171" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1718, - "module": "_client_registry", - "name": "build_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 80 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "BuildCollectionClient", - "target": "2778" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1719, - "module": "_client_registry", - "name": "dataset_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 81 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "DatasetClient", - "target": "2819" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1720, - "module": "_client_registry", - "name": "dataset_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 82 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "DatasetCollectionClient", - "target": "3321" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1721, - "module": "_client_registry", - "name": "key_value_store_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 83 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "KeyValueStoreClient", - "target": "3608" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1722, - "module": "_client_registry", - "name": "key_value_store_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 84 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "KeyValueStoreCollectionClient", - "target": "2372" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1723, - "module": "_client_registry", - "name": "log_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 85 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "LogClient", - "target": "2160" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1724, - "module": "_client_registry", - "name": "request_queue_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 86 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "RequestQueueClient", - "target": "1996" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1725, - "module": "_client_registry", - "name": "request_queue_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 87 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "RequestQueueCollectionClient", - "target": "2480" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1726, - "module": "_client_registry", - "name": "run_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 88 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "RunClient", - "target": "3033" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1727, - "module": "_client_registry", - "name": "run_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 89 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "RunCollectionClient", - "target": "3916" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1728, - "module": "_client_registry", - "name": "schedule_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 90 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ScheduleClient", - "target": "1904" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1729, - "module": "_client_registry", - "name": "schedule_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 91 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ScheduleCollectionClient", - "target": "3219" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1730, - "module": "_client_registry", - "name": "store_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 92 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "StoreCollectionClient", - "target": "2598" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1731, - "module": "_client_registry", - "name": "task_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 93 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "TaskClient", - "target": "2648" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1732, - "module": "_client_registry", - "name": "task_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 94 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "TaskCollectionClient", - "target": "2530" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1733, - "module": "_client_registry", - "name": "user_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 95 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "UserClient", - "target": "1956" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1734, - "module": "_client_registry", - "name": "webhook_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 96 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookClient", - "target": "3856" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1735, - "module": "_client_registry", - "name": "webhook_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 97 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookCollectionClient", - "target": "3794" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1736, - "module": "_client_registry", - "name": "webhook_dispatch_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 98 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookDispatchClient", - "target": "2354" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1737, - "module": "_client_registry", - "name": "webhook_dispatch_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 99 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookDispatchCollectionClient", - "target": "2228" - } - ], - "target": "474" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of all sync client classes for dependency injection.\n\nThis config object is passed to the resource clients to avoid circular dependencies. Each resource client\nreceives this config and can instantiate other clients as needed." - } - ] - }, - "decorations": [ - { - "name": "dataclass" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1711, - 1712, - 1713, - 1714, - 1715, - 1716, - 1717, - 1718, - 1719, - 1720, - 1721, - 1722, - 1723, - 1724, - 1725, - 1726, - 1727, - 1728, - 1729, - 1730, - 1731, - 1732, - 1733, - 1734, - 1735, - 1736, - 1737 - ], - "title": "Properties" - } - ], - "id": 1710, - "module": "_client_registry", - "name": "ClientRegistry", - "parsedDocstring": { - "text": "Bundle of all sync client classes for dependency injection.\n\nThis config object is passed to the resource clients to avoid circular dependencies. Each resource client\nreceives this config and can instantiate other clients as needed." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 66 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1739, - "module": "_client_registry", - "name": "actor_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 110 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ActorClientAsync", - "target": "3506" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1740, - "module": "_client_registry", - "name": "actor_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 111 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ActorCollectionClientAsync", - "target": "2308" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1741, - "module": "_client_registry", - "name": "actor_env_var_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 112 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ActorEnvVarClientAsync", - "target": "3776" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1742, - "module": "_client_registry", - "name": "actor_env_var_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 113 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ActorEnvVarCollectionClientAsync", - "target": "2211" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1743, - "module": "_client_registry", - "name": "actor_version_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 114 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ActorVersionClientAsync", - "target": "2452" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1744, - "module": "_client_registry", - "name": "actor_version_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 115 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ActorVersionCollectionClientAsync", - "target": "3298" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1745, - "module": "_client_registry", - "name": "build_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 116 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "BuildClientAsync", - "target": "3195" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1746, - "module": "_client_registry", - "name": "build_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 117 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "BuildCollectionClientAsync", - "target": "2795" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1747, - "module": "_client_registry", - "name": "dataset_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 118 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "DatasetClientAsync", - "target": "2926" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1748, - "module": "_client_registry", - "name": "dataset_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 119 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "DatasetCollectionClientAsync", - "target": "3347" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1749, - "module": "_client_registry", - "name": "key_value_store_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 120 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "KeyValueStoreClientAsync", - "target": "3683" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1750, - "module": "_client_registry", - "name": "key_value_store_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 121 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "KeyValueStoreCollectionClientAsync", - "target": "2398" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1751, - "module": "_client_registry", - "name": "log_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 122 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "LogClientAsync", - "target": "2177" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1752, - "module": "_client_registry", - "name": "request_queue_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 123 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "RequestQueueClientAsync", - "target": "2078" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1753, - "module": "_client_registry", - "name": "request_queue_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 124 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "RequestQueueCollectionClientAsync", - "target": "2505" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1754, - "module": "_client_registry", - "name": "run_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 125 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "RunClientAsync", - "target": "3102" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1755, - "module": "_client_registry", - "name": "run_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 126 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "RunCollectionClientAsync", - "target": "3939" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1756, - "module": "_client_registry", - "name": "schedule_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 127 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ScheduleClientAsync", - "target": "1930" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1757, - "module": "_client_registry", - "name": "schedule_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 128 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ScheduleCollectionClientAsync", - "target": "3247" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1758, - "module": "_client_registry", - "name": "store_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 129 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "StoreCollectionClientAsync", - "target": "2623" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1759, - "module": "_client_registry", - "name": "task_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 130 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "TaskClientAsync", - "target": "2713" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1760, - "module": "_client_registry", - "name": "task_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 131 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "TaskCollectionClientAsync", - "target": "2564" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1761, - "module": "_client_registry", - "name": "user_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 132 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "UserClientAsync", - "target": "1976" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1762, - "module": "_client_registry", - "name": "webhook_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 133 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookClientAsync", - "target": "3886" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1763, - "module": "_client_registry", - "name": "webhook_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 134 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookCollectionClientAsync", - "target": "3825" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1764, - "module": "_client_registry", - "name": "webhook_dispatch_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 135 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookDispatchClientAsync", - "target": "2363" - } - ], - "target": "474" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1765, - "module": "_client_registry", - "name": "webhook_dispatch_collection_client", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 136 - } - ], - "type": { - "name": "type", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookDispatchCollectionClientAsync", - "target": "2245" - } - ], - "target": "474" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of all async client classes for dependency injection.\n\nThis config object is passed to the resource clients to avoid circular dependencies. Each resource client\nreceives this config and can instantiate other clients as needed." - } - ] - }, - "decorations": [ - { - "name": "dataclass" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1739, - 1740, - 1741, - 1742, - 1743, - 1744, - 1745, - 1746, - 1747, - 1748, - 1749, - 1750, - 1751, - 1752, - 1753, - 1754, - 1755, - 1756, - 1757, - 1758, - 1759, - 1760, - 1761, - 1762, - 1763, - 1764, - 1765 - ], - "title": "Properties" - } - ], - "id": 1738, - "module": "_client_registry", - "name": "ClientRegistryAsync", - "parsedDocstring": { - "text": "Bundle of all async client classes for dependency injection.\n\nThis config object is passed to the resource clients to avoid circular dependencies. Each resource client\nreceives this config and can instantiate other clients as needed." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_client_registry.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 103 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1766, - "module": "_pagination", - "name": "T", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_pagination.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 10 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default per-page size used by the iterate helpers when the caller does not specify one.\n\nThe value of 1000 keeps backwards compatibility with the previous fixed cache size." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1767, - "module": "_pagination", - "name": "DEFAULT_CHUNK_SIZE", - "parsedDocstring": { - "text": "Default per-page size used by the iterate helpers when the caller does not specify one.\n\nThe value of 1000 keeps backwards compatibility with the previous fixed cache size." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_pagination.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 12 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1769, - "module": "_pagination", - "name": "items", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_pagination.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 27 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "T", - "target": "9" - } - ], - "target": "2199" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Structural contract for a single page of results from a paginated API endpoint.\n\nImplementations must expose `items`. They may optionally expose `count` — the number of items scanned by the API for\nthis page, which can exceed `len(items)` when filters drop items from the response. The iterator helpers consult\n`count` opportunistically via `getattr` for offset bookkeeping and fall back to `len(items)` when it is absent." - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 1769 - ], - "title": "Properties" - } - ], - "id": 1768, - "module": "_pagination", - "name": "HasItems", - "parsedDocstring": { - "text": "Structural contract for a single page of results from a paginated API endpoint.\n\nImplementations must expose `items`. They may optionally expose `count` — the number of items scanned by the API for\nthis page, which can exceed `len(items)` when filters drop items from the response. The iterator helpers consult\n`count` opportunistically via `getattr` for offset bookkeeping and fall back to `len(items)` when it is absent." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_pagination.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 19 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Yield individual items from offset-based paginated API responses.\n\nThe `callback` is invoked lazily to fetch each page from the API. It must accept `limit` and `offset` keyword\narguments and return an object whose `items` attribute is a list. If the object also exposes a `count` attribute, it\nis used for offset bookkeeping (the Apify API's `count` reflects items scanned, which can exceed items returned when\nfilters are applied).\n\nIteration stops when a page returns no items or when the user-requested `limit` is reached. The `total` field is\nintentionally not consulted, because it can change between calls.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1770, - "module": "_pagination", - "name": "get_items_iterator", - "parsedDocstring": { - "text": "Yield individual items from offset-based paginated API responses.\n\nThe `callback` is invoked lazily to fetch each page from the API. It must accept `limit` and `offset` keyword\narguments and return an object whose `items` attribute is a list. If the object also exposes a `count` attribute, it\nis used for offset bookkeeping (the Apify API's `count` reflects items scanned, which can exceed items returned when\nfilters are applied).\n\nIteration stops when a page returns no items or when the user-requested `limit` is reached. The `total` field is\nintentionally not consulted, because it can change between calls.\n", - "args": { - "callback": "Function returning a single page of items.", - "limit": "Maximum total number of items to yield across all pages. `None` or `0` means no limit.", - "offset": "Starting offset for the first page.", - "chunk_size": "Maximum number of items requested per API call. `None` or `0` lets the API decide." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_pagination.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 30 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Yield individual items from offset-based paginated API responses.\n\nThe `callback` is invoked lazily to fetch each page from the API. It must accept `limit` and `offset` keyword\narguments and return an object whose `items` attribute is a list. If the object also exposes a `count` attribute, it\nis used for offset bookkeeping (the Apify API's `count` reflects items scanned, which can exceed items returned when\nfilters are applied).\n\nIteration stops when a page returns no items or when the user-requested `limit` is reached. The `total` field is\nintentionally not consulted, because it can change between calls.\n" - } - ] - }, - "flags": {}, - "id": 1771, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_items_iterator", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Function returning a single page of items." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1772, - "kind": 32768, - "kindString": "Parameter", - "name": "callback", - "type": { - "name": "Callable", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "..." - }, - { - "type": "reference", - "name": "HasItems", - "typeArguments": [ - { - "type": "reference", - "name": "T", - "target": "9" - } - ], - "target": "1768" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum total number of items to yield across all pages. `None` or `0` means no limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1773, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starting offset for the first page." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1774, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items requested per API call. `None` or `0` lets the API decide." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1775, - "kind": 32768, - "kindString": "Parameter", - "name": "chunk_size", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "T", - "target": "9" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Async variant of :func:`get_items_iterator`.\n\nThe `callback` must be an awaitable returning a single page of items." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1776, - "module": "_pagination", - "name": "get_items_iterator_async", - "parsedDocstring": { - "text": "Async variant of :func:`get_items_iterator`.\n\nThe `callback` must be an awaitable returning a single page of items." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_pagination.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 71 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Async variant of :func:`get_items_iterator`.\n\nThe `callback` must be an awaitable returning a single page of items." - } - ] - }, - "flags": {}, - "id": 1777, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_items_iterator_async", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1778, - "kind": 32768, - "kindString": "Parameter", - "name": "callback", - "type": { - "name": "Callable", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "..." - }, - { - "type": "reference", - "name": "Awaitable", - "typeArguments": [ - { - "type": "reference", - "name": "HasItems", - "typeArguments": [ - { - "type": "reference", - "name": "T", - "target": "9" - } - ], - "target": "1768" - } - ] - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1779, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1780, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1781, - "kind": 32768, - "kindString": "Parameter", - "name": "chunk_size", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "T", - "target": "9" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Yield individual items from cursor-paginated API responses.\n\nCursor pagination is restricted to the two API responses that expose it: `ListOfKeys` (for key-value store keys) and\n`ListOfRequests` (for request queue requests). Iteration ends when a page returns no items, the next cursor is\n`None`, or the user-requested `limit` is reached.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1782, - "module": "_pagination", - "name": "get_cursor_iterator", - "parsedDocstring": { - "text": "Yield individual items from cursor-paginated API responses.\n\nCursor pagination is restricted to the two API responses that expose it: `ListOfKeys` (for key-value store keys) and\n`ListOfRequests` (for request queue requests). Iteration ends when a page returns no items, the next cursor is\n`None`, or the user-requested `limit` is reached.\n", - "args": { - "callback": "Function returning a single page of items. Receives `cursor` and `limit` kwargs.", - "cursor": "Value of the cursor for the first request, or `None` to start from the beginning.", - "limit": "Maximum total number of items to yield across all pages.", - "chunk_size": "Maximum number of items requested per API call." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_pagination.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 117 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Yield individual items from cursor-paginated API responses.\n\nCursor pagination is restricted to the two API responses that expose it: `ListOfKeys` (for key-value store keys) and\n`ListOfRequests` (for request queue requests). Iteration ends when a page returns no items, the next cursor is\n`None`, or the user-requested `limit` is reached.\n" - } - ] - }, - "flags": {}, - "id": 1783, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_cursor_iterator", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Function returning a single page of items. Receives `cursor` and `limit` kwargs." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1784, - "kind": 32768, - "kindString": "Parameter", - "name": "callback", - "type": { - "name": "Callable", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "..." - }, - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "ListOfKeys", - "target": "667" - }, - { - "type": "reference", - "name": "ListOfRequests", - "target": "681" - } - ] - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Value of the cursor for the first request, or `None` to start from the beginning." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1785, - "kind": 32768, - "kindString": "Parameter", - "name": "cursor", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum total number of items to yield across all pages." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1786, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items requested per API call." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1787, - "kind": 32768, - "kindString": "Parameter", - "name": "chunk_size", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "Iterator[KeyValueStoreKey] | Iterator[Request]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Iterator", - "typeArguments": [ - { - "type": "reference", - "name": "KeyValueStoreKey", - "target": "611" - } - ] - }, - { - "type": "reference", - "name": "Iterator", - "typeArguments": [ - { - "type": "reference", - "name": "Request", - "target": "876" - } - ] - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Async variant of :func:`get_cursor_iterator`." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1788, - "module": "_pagination", - "name": "get_cursor_iterator_async", - "parsedDocstring": { - "text": "Async variant of :func:`get_cursor_iterator`." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_pagination.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 172 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Async variant of :func:`get_cursor_iterator`." - } - ] - }, - "flags": {}, - "id": 1789, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_cursor_iterator_async", - "parameters": [ - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 1790, - "kind": 32768, - "kindString": "Parameter", - "name": "callback", - "type": { - "name": "Callable", - "type": "reference", - "typeArguments": [ - { - "type": "literal", - "value": "..." - }, - { - "type": "reference", - "name": "Awaitable", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "ListOfKeys", - "target": "667" - }, - { - "type": "reference", - "name": "ListOfRequests", - "target": "681" - } - ] - } - ] - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1791, - "kind": 32768, - "kindString": "Parameter", - "name": "cursor", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1792, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1793, - "kind": 32768, - "kindString": "Parameter", - "name": "chunk_size", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "AsyncIterator[KeyValueStoreKey] | AsyncIterator[Request]", - "type": "union", - "types": [ - { - "type": "reference", - "name": "AsyncIterator", - "typeArguments": [ - { - "type": "reference", - "name": "KeyValueStoreKey", - "target": "611" - } - ] - }, - { - "type": "reference", - "name": "AsyncIterator", - "typeArguments": [ - { - "type": "reference", - "name": "Request", - "target": "876" - } - ] - } - ] - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Status of an Actor job (run or build)." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1794, - "module": "_literals", - "name": "ActorJobStatus", - "parsedDocstring": { - "text": "Status of an Actor job (run or build)." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_literals.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 7 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines permissions that the Actor requires to run. For more information, see the [Actor permissions documentation](https://docs.apify.com/platform/actors/development/permissions)." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1795, - "module": "_literals", - "name": "ActorPermissionLevel", - "parsedDocstring": { - "text": "Determines permissions that the Actor requires to run. For more information, see the [Actor permissions documentation](https://docs.apify.com/platform/actors/development/permissions)." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_literals.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 20 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Machine-processable error type identifier." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1796, - "module": "_literals", - "name": "ErrorType", - "parsedDocstring": { - "text": "Machine-processable error type identifier." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_literals.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 27 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Defines the general access level for the resource." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1797, - "module": "_literals", - "name": "GeneralAccess", - "parsedDocstring": { - "text": "Defines the general access level for the resource." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_literals.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 421 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1798, - "module": "_literals", - "name": "HttpMethod", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_literals.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 430 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1799, - "module": "_literals", - "name": "RunOrigin", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_literals.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 443 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1800, - "module": "_literals", - "name": "SourceCodeFileFormat", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_literals.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 456 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1801, - "module": "_literals", - "name": "StorageOwnership", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_literals.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 462 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1802, - "module": "_literals", - "name": "VersionSourceType", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_literals.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 468 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Status of the webhook dispatch indicating whether the HTTP request was successful." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1803, - "module": "_literals", - "name": "WebhookDispatchStatus", - "parsedDocstring": { - "text": "Status of the webhook dispatch indicating whether the HTTP request was successful." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_literals.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 476 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of event that triggers the webhook." - } - ] - }, - "flags": {}, - "groups": [], - "id": 1804, - "module": "_literals", - "name": "WebhookEventType", - "parsedDocstring": { - "text": "Type of event that triggers the webhook." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_literals.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 484 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code of the response." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 1806, - "module": "http_clients._base", - "name": "status_code", - "parsedDocstring": { - "text": "HTTP status code of the response." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 42 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response body decoded as text." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 1807, - "module": "http_clients._base", - "name": "text", - "parsedDocstring": { - "text": "Response body decoded as text." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 46 - } - ], - "type": { - "name": "str", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Raw response body as bytes." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 1808, - "module": "http_clients._base", - "name": "content", - "parsedDocstring": { - "text": "Raw response body as bytes." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 50 - } - ], - "type": { - "name": "bytes", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Response headers as a mapping." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 1809, - "module": "http_clients._base", - "name": "headers", - "parsedDocstring": { - "text": "Response headers as a mapping." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 54 - } - ], - "type": { - "name": "Mapping", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "str" - } - ] - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parse response body as JSON." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1810, - "module": "http_clients._base", - "name": "json", - "parsedDocstring": { - "text": "Parse response body as JSON." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 57 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parse response body as JSON." - } - ] - }, - "flags": {}, - "id": 1811, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "json", - "parameters": [], - "type": { - "name": "Any", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Read the entire response body." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1812, - "module": "http_clients._base", - "name": "read", - "parsedDocstring": { - "text": "Read the entire response body." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 60 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Read the entire response body." - } - ] - }, - "flags": {}, - "id": 1813, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "read", - "parameters": [], - "type": { - "name": "bytes", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Read the entire response body asynchronously." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1814, - "module": "http_clients._base", - "name": "aread", - "parsedDocstring": { - "text": "Read the entire response body asynchronously." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 63 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Read the entire response body asynchronously." - } - ] - }, - "flags": {}, - "id": 1815, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "aread", - "parameters": [], - "type": { - "name": "bytes", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Close the response and release the connection." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1816, - "module": "http_clients._base", - "name": "close", - "parsedDocstring": { - "text": "Close the response and release the connection." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 66 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Close the response and release the connection." - } - ] - }, - "flags": {}, - "id": 1817, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "close", - "parameters": [], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Close the response and release the connection asynchronously." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1818, - "module": "http_clients._base", - "name": "aclose", - "parsedDocstring": { - "text": "Close the response and release the connection asynchronously." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 69 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Close the response and release the connection asynchronously." - } - ] - }, - "flags": {}, - "id": 1819, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "aclose", - "parameters": [], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the response body in bytes chunks." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1820, - "module": "http_clients._base", - "name": "iter_bytes", - "parsedDocstring": { - "text": "Iterate over the response body in bytes chunks." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the response body in bytes chunks." - } - ] - }, - "flags": {}, - "id": 1821, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iter_bytes", - "parameters": [], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "bytes" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the response body in bytes chunks asynchronously." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1822, - "module": "http_clients._base", - "name": "aiter_bytes", - "parsedDocstring": { - "text": "Iterate over the response body in bytes chunks asynchronously." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 75 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the response body in bytes chunks asynchronously." - } - ] - }, - "flags": {}, - "id": 1823, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "aiter_bytes", - "parameters": [], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "bytes" - } - ] - } - } - ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Protocol for HTTP response objects returned by HTTP clients.\n\nAny object that has the required attributes and methods can be used as an HTTP response\n(e.g., `impit.Response`). This enables custom HTTP client implementations to return\ntheir own response types." - } - ] - }, - "decorations": [ - { - "args": "('HTTP clients')", - "name": "docs_group" - }, - { - "name": "runtime_checkable" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1818, - 1822, - 1814, - 1816, - 1820, - 1810, - 1812 - ], - "title": "Methods" - }, - { - "children": [ - 1808, - 1809, - 1806, - 1807 - ], - "title": "Properties" - } - ], - "id": 1805, - "module": "http_clients._base", - "name": "HttpResponse", - "parsedDocstring": { - "text": "Protocol for HTTP response objects returned by HTTP clients.\n\nAny object that has the required attributes and methods can be used as an HTTP response\n(e.g., `impit.Response`). This enables custom HTTP client implementations to return\ntheir own response types." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 33 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the HTTP client base.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1825, - "module": "http_clients._base", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the HTTP client base.\n", - "args": { - "token": "Apify API token for authentication.", - "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).", - "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).", - "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).", - "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.", - "max_retries": "Maximum number of retries for failed requests.", - "min_delay_between_retries": "Minimum delay between retries.", - "statistics": "Statistics tracker for API calls. Created automatically if not provided.", - "headers": "Additional HTTP headers to include in all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 91 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the HTTP client base.\n" - } - ] - }, - "flags": {}, - "id": 1826, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Apify API token for authentication." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1827, - "kind": 32768, - "kindString": "Parameter", - "name": "token", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_SHORT", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1828, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_short", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_MEDIUM", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1829, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_medium", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_LONG", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1830, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_long", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum timeout cap for exponential timeout growth across retries." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_MAX", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1831, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_max", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of retries for failed requests." - } - ] - }, - "defaultValue": "DEFAULT_MAX_RETRIES", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1832, - "kind": 32768, - "kindString": "Parameter", - "name": "max_retries", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Minimum delay between retries." - } - ] - }, - "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1833, - "kind": 32768, - "kindString": "Parameter", - "name": "min_delay_between_retries", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statistics tracker for API calls. Created automatically if not provided." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1834, - "kind": 32768, - "kindString": "Parameter", - "name": "statistics", - "type": { - "name": "ClientStatistics | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ClientStatistics", - "target": "1" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional HTTP headers to include in all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1835, - "kind": 32768, - "kindString": "Parameter", - "name": "headers", - "type": { - "name": "dict[str, str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "str" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Shared configuration and utilities for HTTP clients.\n\nProvides common functionality for both sync and async HTTP clients including:\nheader construction, parameter parsing, request body preparation, URL building,\nand timeout calculation.\n\nSubclasses should call `super().__init__()` to initialize shared configuration.\nThe helper methods are then available for use in the `call()` implementation." - } - ] - }, - "decorations": [ - { - "args": "('HTTP clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1825 - ], - "title": "Methods" - } - ], - "id": 1824, - "module": "http_clients._base", - "name": "HttpClientBase", - "parsedDocstring": { - "text": "Shared configuration and utilities for HTTP clients.\n\nProvides common functionality for both sync and async HTTP clients including:\nheader construction, parameter parsing, request body preparation, URL building,\nand timeout calculation.\n\nSubclasses should call `super().__init__()` to initialize shared configuration.\nThe helper methods are then available for use in the `call()` implementation." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 80 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "HttpClient", - "target": "1836", - "type": "reference" - }, - { - "name": "HttpClientAsync", - "target": "1847", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Make an HTTP request.\n" - } - ] - }, - "decorations": [ - { - "name": "abstractmethod" - } - ], - "flags": {}, - "groups": [], - "id": 1837, - "module": "http_clients._base", - "name": "call", - "parsedDocstring": { - "text": "Make an HTTP request.\n", - "args": { - "method": "HTTP method (GET, POST, PUT, DELETE, etc.).", - "url": "Full URL to make the request to.", - "headers": "Additional headers to include in this request.", - "params": "Query parameters to append to the URL.", - "data": "Raw request body data. Cannot be used together with json.", - "json": "JSON-serializable data for the request body. Cannot be used together with data.", - "stream": "Whether to stream the response body.", - "timeout": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n" - }, - "returns": "The HTTP response object." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 252 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The HTTP response object." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Make an HTTP request.\n" - } - ] - }, - "flags": {}, - "id": 1838, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "call", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP method (GET, POST, PUT, DELETE, etc.)." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 1839, - "kind": 32768, - "kindString": "Parameter", - "name": "method", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Full URL to make the request to." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 1840, - "kind": 32768, - "kindString": "Parameter", - "name": "url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional headers to include in this request." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1841, - "kind": 32768, - "kindString": "Parameter", - "name": "headers", - "type": { - "name": "dict[str, str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "str" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query parameters to append to the URL." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1842, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict[str, Any] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Raw request body data. Cannot be used together with json." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1843, - "kind": 32768, - "kindString": "Parameter", - "name": "data", - "type": { - "name": "str | bytes | bytearray | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "bytes" - } - ] - }, - { - "type": "reference", - "name": "bytearray" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "JSON-serializable data for the request body. Cannot be used together with data." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1844, - "kind": 32768, - "kindString": "Parameter", - "name": "json", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to stream the response body." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1845, - "kind": 32768, - "kindString": "Parameter", - "name": "stream", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1846, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "HttpResponse", - "type": "reference", - "target": "1805" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the HTTP client base.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 4018, - "module": "http_clients._base", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the HTTP client base.\n", - "args": { - "token": "Apify API token for authentication.", - "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).", - "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).", - "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).", - "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.", - "max_retries": "Maximum number of retries for failed requests.", - "min_delay_between_retries": "Minimum delay between retries.", - "statistics": "Statistics tracker for API calls. Created automatically if not provided.", - "headers": "Additional HTTP headers to include in all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 91 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the HTTP client base.\n" - } - ] - }, - "flags": {}, - "id": 1826, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Apify API token for authentication." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1827, - "kind": 32768, - "kindString": "Parameter", - "name": "token", - "type": { - "name": "str | None", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_SHORT", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1828, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_short", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_MEDIUM", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1829, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_medium", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_LONG", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1830, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_long", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum timeout cap for exponential timeout growth across retries." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_MAX", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1831, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_max", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of retries for failed requests." - } - ] - }, - "defaultValue": "DEFAULT_MAX_RETRIES", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1832, - "kind": 32768, - "kindString": "Parameter", - "name": "max_retries", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Minimum delay between retries." - } - ] - }, - "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1833, - "kind": 32768, - "kindString": "Parameter", - "name": "min_delay_between_retries", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statistics tracker for API calls. Created automatically if not provided." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1834, - "kind": 32768, - "kindString": "Parameter", - "name": "statistics", - "type": { - "name": "ClientStatistics | None", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional HTTP headers to include in all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1835, - "kind": 32768, - "kindString": "Parameter", - "name": "headers", - "type": { - "name": "dict[str, str] | None", - "type": "reference" - } - } - ], - "type": { - "name": "None", - "type": "reference" - }, - "inheritedFrom": { - "name": "HttpClientBase.__init__", - "target": 1825, - "type": "reference" - } - } - ], - "inheritedFrom": { - "name": "HttpClientBase.__init__", - "target": 1825, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Abstract base class for synchronous HTTP clients used by `ApifyClient`.\n\nExtend this class to create a custom synchronous HTTP client. Override the `call` method\nwith your implementation. Helper methods from the base class are available for request\npreparation, URL building, and parameter parsing." - } - ] - }, - "decorations": [ - { - "args": "('HTTP clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4018, - 1837 - ], - "title": "Methods" - } - ], - "id": 1836, - "module": "http_clients._base", - "name": "HttpClient", - "parsedDocstring": { - "text": "Abstract base class for synchronous HTTP clients used by `ApifyClient`.\n\nExtend this class to create a custom synchronous HTTP client. Override the `call` method\nwith your implementation. Helper methods from the base class are available for request\npreparation, URL building, and parameter parsing." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 243 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "HttpClientBase", - "target": "1824", - "type": "reference" - } - ], - "extendedBy": [ - { - "name": "ImpitHttpClient", - "target": "1860", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Make an HTTP request.\n" - } - ] - }, - "decorations": [ - { - "name": "abstractmethod" - } - ], - "flags": {}, - "groups": [], - "id": 1848, - "module": "http_clients._base", - "name": "call", - "parsedDocstring": { - "text": "Make an HTTP request.\n", - "args": { - "method": "HTTP method (GET, POST, PUT, DELETE, etc.).", - "url": "Full URL to make the request to.", - "headers": "Additional headers to include in this request.", - "params": "Query parameters to append to the URL.", - "data": "Raw request body data. Cannot be used together with json.", - "json": "JSON-serializable data for the request body. Cannot be used together with data.", - "stream": "Whether to stream the response body.", - "timeout": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n" - }, - "returns": "The HTTP response object." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 296 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The HTTP response object." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Make an HTTP request.\n" - } - ] - }, - "flags": {}, - "id": 1849, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "call", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP method (GET, POST, PUT, DELETE, etc.)." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 1850, - "kind": 32768, - "kindString": "Parameter", - "name": "method", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Full URL to make the request to." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 1851, - "kind": 32768, - "kindString": "Parameter", - "name": "url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional headers to include in this request." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1852, - "kind": 32768, - "kindString": "Parameter", - "name": "headers", - "type": { - "name": "dict[str, str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "str" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query parameters to append to the URL." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1853, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict[str, Any] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Raw request body data. Cannot be used together with json." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1854, - "kind": 32768, - "kindString": "Parameter", - "name": "data", - "type": { - "name": "str | bytes | bytearray | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "bytes" - } - ] - }, - { - "type": "reference", - "name": "bytearray" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "JSON-serializable data for the request body. Cannot be used together with data." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1855, - "kind": 32768, - "kindString": "Parameter", - "name": "json", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to stream the response body." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1856, - "kind": 32768, - "kindString": "Parameter", - "name": "stream", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1857, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "HttpResponse", - "type": "reference", - "target": "1805" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the HTTP client base.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 4019, - "module": "http_clients._base", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the HTTP client base.\n", - "args": { - "token": "Apify API token for authentication.", - "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).", - "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).", - "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).", - "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.", - "max_retries": "Maximum number of retries for failed requests.", - "min_delay_between_retries": "Minimum delay between retries.", - "statistics": "Statistics tracker for API calls. Created automatically if not provided.", - "headers": "Additional HTTP headers to include in all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 91 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the HTTP client base.\n" - } - ] - }, - "flags": {}, - "id": 1826, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Apify API token for authentication." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1827, - "kind": 32768, - "kindString": "Parameter", - "name": "token", - "type": { - "name": "str | None", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_SHORT", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1828, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_short", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_MEDIUM", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1829, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_medium", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_LONG", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1830, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_long", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum timeout cap for exponential timeout growth across retries." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_MAX", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1831, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_max", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of retries for failed requests." - } - ] - }, - "defaultValue": "DEFAULT_MAX_RETRIES", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1832, - "kind": 32768, - "kindString": "Parameter", - "name": "max_retries", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Minimum delay between retries." - } - ] - }, - "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1833, - "kind": 32768, - "kindString": "Parameter", - "name": "min_delay_between_retries", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statistics tracker for API calls. Created automatically if not provided." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1834, - "kind": 32768, - "kindString": "Parameter", - "name": "statistics", - "type": { - "name": "ClientStatistics | None", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional HTTP headers to include in all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1835, - "kind": 32768, - "kindString": "Parameter", - "name": "headers", - "type": { - "name": "dict[str, str] | None", - "type": "reference" - } - } - ], - "type": { - "name": "None", - "type": "reference" - }, - "inheritedFrom": { - "name": "HttpClientBase.__init__", - "target": 1825, - "type": "reference" - } - } - ], - "inheritedFrom": { - "name": "HttpClientBase.__init__", - "target": 1825, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Abstract base class for asynchronous HTTP clients used by `ApifyClientAsync`.\n\nExtend this class to create a custom asynchronous HTTP client. See `HttpClient`\nfor details on the expected behavior." - } - ] - }, - "decorations": [ - { - "args": "('HTTP clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 4019, - 1848 - ], - "title": "Methods" - } - ], - "id": 1847, - "module": "http_clients._base", - "name": "HttpClientAsync", - "parsedDocstring": { - "text": "Abstract base class for asynchronous HTTP clients used by `ApifyClientAsync`.\n\nExtend this class to create a custom asynchronous HTTP client. See `HttpClient`\nfor details on the expected behavior." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_base.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 288 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "HttpClientBase", - "target": "1824", - "type": "reference" - } - ], - "extendedBy": [ - { - "name": "ImpitHttpClientAsync", - "target": "1882", - "type": "reference" - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1858, - "module": "http_clients._impit", - "name": "T", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_impit.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 34 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "" - } - ] - }, - "flags": {}, - "groups": [], - "id": 1859, - "module": "http_clients._impit", - "name": "logger", - "parsedDocstring": { - "text": "" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_impit.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 36 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the Impit-based synchronous HTTP client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1861, - "module": "http_clients._impit", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the Impit-based synchronous HTTP client.\n", - "args": { - "token": "Apify API token for authentication.", - "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).", - "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).", - "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).", - "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.", - "max_retries": "Maximum number of retry attempts for failed requests.", - "min_delay_between_retries": "Minimum delay between retries (increases exponentially with each attempt).", - "statistics": "Statistics tracker for API calls. Created automatically if not provided.", - "headers": "Additional HTTP headers to include in all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_impit.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 64 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the Impit-based synchronous HTTP client.\n" - } - ] - }, - "flags": {}, - "id": 1862, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Apify API token for authentication." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1863, - "kind": 32768, - "kindString": "Parameter", - "name": "token", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_SHORT", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1864, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_short", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_MEDIUM", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1865, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_medium", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_LONG", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1866, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_long", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum timeout cap for exponential timeout growth across retries." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_MAX", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1867, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_max", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of retry attempts for failed requests." - } - ] - }, - "defaultValue": "DEFAULT_MAX_RETRIES", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1868, - "kind": 32768, - "kindString": "Parameter", - "name": "max_retries", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Minimum delay between retries (increases exponentially with each attempt)." - } - ] - }, - "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1869, - "kind": 32768, - "kindString": "Parameter", - "name": "min_delay_between_retries", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statistics tracker for API calls. Created automatically if not provided." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1870, - "kind": 32768, - "kindString": "Parameter", - "name": "statistics", - "type": { - "name": "ClientStatistics | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ClientStatistics", - "target": "1" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional HTTP headers to include in all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1871, - "kind": 32768, - "kindString": "Parameter", - "name": "headers", - "type": { - "name": "dict[str, str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "str" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "HttpClient.__init__", - "target": 4018, - "type": "reference" - } - } - ], - "overwrites": { - "name": "HttpClient.__init__", - "target": 4018, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Make an HTTP request with automatic retry and exponential backoff.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1872, - "module": "http_clients._impit", - "name": "call", - "parsedDocstring": { - "text": "Make an HTTP request with automatic retry and exponential backoff.\n", - "args": { - "method": "HTTP method (GET, POST, PUT, DELETE, etc.).", - "url": "Full URL to make the request to.", - "headers": "Additional headers to include.", - "params": "Query parameters to append to the URL.", - "data": "Raw request body data. Cannot be used together with json.", - "json": "JSON-serializable data for the request body. Cannot be used together with data.", - "stream": "Whether to stream the response body.", - "timeout": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n" - }, - "returns": "The HTTP response object." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_impit.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 107 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The HTTP response object." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Make an HTTP request with automatic retry and exponential backoff.\n" - } - ] - }, - "flags": {}, - "id": 1873, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "call", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP method (GET, POST, PUT, DELETE, etc.)." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 1874, - "kind": 32768, - "kindString": "Parameter", - "name": "method", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Full URL to make the request to." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 1875, - "kind": 32768, - "kindString": "Parameter", - "name": "url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional headers to include." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1876, - "kind": 32768, - "kindString": "Parameter", - "name": "headers", - "type": { - "name": "dict[str, str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "str" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query parameters to append to the URL." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1877, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict[str, Any] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Raw request body data. Cannot be used together with json." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1878, - "kind": 32768, - "kindString": "Parameter", - "name": "data", - "type": { - "name": "str | bytes | bytearray | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "bytes" - } - ] - }, - { - "type": "reference", - "name": "bytearray" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "JSON-serializable data for the request body. Cannot be used together with data." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1879, - "kind": 32768, - "kindString": "Parameter", - "name": "json", - "type": { - "name": "JsonSerializable | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "JsonSerializable", - "target": "15" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to stream the response body." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1880, - "kind": 32768, - "kindString": "Parameter", - "name": "stream", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1881, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "HttpResponse", - "type": "reference", - "target": "1805" - }, - "overwrites": { - "name": "HttpClient.call", - "target": 1837, - "type": "reference" - } - } - ], - "overwrites": { - "name": "HttpClient.call", - "target": 1837, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Synchronous HTTP client for the Apify API built on top of [Impit](https://github.com/apify/impit).\n\nImpit is a high-performance HTTP client written in Rust that provides browser-like TLS fingerprints,\nautomatic header ordering, and HTTP/2 support. This client wraps `impit.Client` and adds automatic retries\nwith exponential backoff for rate-limited (HTTP 429) and server error (HTTP 5xx) responses." - } - ] - }, - "decorations": [ - { - "args": "('HTTP clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1861, - 1872 - ], - "title": "Methods" - } - ], - "id": 1860, - "module": "http_clients._impit", - "name": "ImpitHttpClient", - "parsedDocstring": { - "text": "Synchronous HTTP client for the Apify API built on top of [Impit](https://github.com/apify/impit).\n\nImpit is a high-performance HTTP client written in Rust that provides browser-like TLS fingerprints,\nautomatic header ordering, and HTTP/2 support. This client wraps `impit.Client` and adds automatic retries\nwith exponential backoff for rate-limited (HTTP 429) and server error (HTTP 5xx) responses." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_impit.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 56 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "HttpClient", - "target": "1836", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the Impit-based asynchronous HTTP client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1883, - "module": "http_clients._impit", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the Impit-based asynchronous HTTP client.\n", - "args": { - "token": "Apify API token for authentication.", - "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).", - "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).", - "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).", - "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.", - "max_retries": "Maximum number of retry attempts for failed requests.", - "min_delay_between_retries": "Minimum delay between retries (increases exponentially with each attempt).", - "statistics": "Statistics tracker for API calls. Created automatically if not provided.", - "headers": "Additional HTTP headers to include in all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_impit.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 311 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the Impit-based asynchronous HTTP client.\n" - } - ] - }, - "flags": {}, - "id": 1884, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Apify API token for authentication." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1885, - "kind": 32768, - "kindString": "Parameter", - "name": "token", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_SHORT", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1886, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_short", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_MEDIUM", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1887, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_medium", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_LONG", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1888, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_long", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum timeout cap for exponential timeout growth across retries." - } - ] - }, - "defaultValue": "DEFAULT_TIMEOUT_MAX", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1889, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout_max", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of retry attempts for failed requests." - } - ] - }, - "defaultValue": "DEFAULT_MAX_RETRIES", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1890, - "kind": 32768, - "kindString": "Parameter", - "name": "max_retries", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Minimum delay between retries (increases exponentially with each attempt)." - } - ] - }, - "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1891, - "kind": 32768, - "kindString": "Parameter", - "name": "min_delay_between_retries", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statistics tracker for API calls. Created automatically if not provided." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1892, - "kind": 32768, - "kindString": "Parameter", - "name": "statistics", - "type": { - "name": "ClientStatistics | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ClientStatistics", - "target": "1" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional HTTP headers to include in all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1893, - "kind": 32768, - "kindString": "Parameter", - "name": "headers", - "type": { - "name": "dict[str, str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "str" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "HttpClientAsync.__init__", - "target": 4019, - "type": "reference" - } - } - ], - "overwrites": { - "name": "HttpClientAsync.__init__", - "target": 4019, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Make an HTTP request with automatic retry and exponential backoff.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1894, - "module": "http_clients._impit", - "name": "call", - "parsedDocstring": { - "text": "Make an HTTP request with automatic retry and exponential backoff.\n", - "args": { - "method": "HTTP method (GET, POST, PUT, DELETE, etc.).", - "url": "Full URL to make the request to.", - "headers": "Additional headers to include.", - "params": "Query parameters to append to the URL.", - "data": "Raw request body data. Cannot be used together with json.", - "json": "JSON-serializable data for the request body. Cannot be used together with data.", - "stream": "Whether to stream the response body.", - "timeout": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n" - }, - "returns": "The HTTP response object." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_impit.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 354 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The HTTP response object." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Make an HTTP request with automatic retry and exponential backoff.\n" - } - ] - }, - "flags": {}, - "id": 1895, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "call", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP method (GET, POST, PUT, DELETE, etc.)." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 1896, - "kind": 32768, - "kindString": "Parameter", - "name": "method", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Full URL to make the request to." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 1897, - "kind": 32768, - "kindString": "Parameter", - "name": "url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional headers to include." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1898, - "kind": 32768, - "kindString": "Parameter", - "name": "headers", - "type": { - "name": "dict[str, str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "str" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Query parameters to append to the URL." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1899, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict[str, Any] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Raw request body data. Cannot be used together with json." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1900, - "kind": 32768, - "kindString": "Parameter", - "name": "data", - "type": { - "name": "str | bytes | bytearray | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "bytes" - } - ] - }, - { - "type": "reference", - "name": "bytearray" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "JSON-serializable data for the request body. Cannot be used together with data." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1901, - "kind": 32768, - "kindString": "Parameter", - "name": "json", - "type": { - "name": "JsonSerializable | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "JsonSerializable", - "target": "15" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to stream the response body." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1902, - "kind": 32768, - "kindString": "Parameter", - "name": "stream", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1903, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "HttpResponse", - "type": "reference", - "target": "1805" - }, - "overwrites": { - "name": "HttpClientAsync.call", - "target": 1848, - "type": "reference" - } - } - ], - "overwrites": { - "name": "HttpClientAsync.call", - "target": 1848, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Asynchronous HTTP client for the Apify API built on top of [Impit](https://github.com/apify/impit).\n\nImpit is a high-performance HTTP client written in Rust that provides browser-like TLS fingerprints,\nautomatic header ordering, and HTTP/2 support. This client wraps `impit.AsyncClient` and adds automatic retries\nwith exponential backoff for rate-limited (HTTP 429) and server error (HTTP 5xx) responses." - } - ] - }, - "decorations": [ - { - "args": "('HTTP clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1883, - 1894 - ], - "title": "Methods" - } - ], - "id": 1882, - "module": "http_clients._impit", - "name": "ImpitHttpClientAsync", - "parsedDocstring": { - "text": "Asynchronous HTTP client for the Apify API built on top of [Impit](https://github.com/apify/impit).\n\nImpit is a high-performance HTTP client written in Rust that provides browser-like TLS fingerprints,\nautomatic header ordering, and HTTP/2 support. This client wraps `impit.AsyncClient` and adds automatic retries\nwith exponential backoff for rate-limited (HTTP 429) and server error (HTTP 5xx) responses." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/http_clients/_impit.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 303 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "HttpClientAsync", - "target": "1847", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1905, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 28 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1910, - "module": "_resource_clients.schedule", - "name": "get", - "parsedDocstring": { - "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved schedule." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 41 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved schedule." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n" - } - ] - }, - "flags": {}, - "id": 1911, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1912, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Schedule | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Schedule", - "target": "1115" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1913, - "module": "_resource_clients.schedule", - "name": "update", - "parsedDocstring": { - "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n", - "args": { - "cron_expression": "The cron expression used by this schedule.", - "is_enabled": "True if the schedule should be enabled.", - "is_exclusive": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule.", - "name": "The name of the schedule to create.", - "actions": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure.", - "description": "Description of this schedule.", - "timezone": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones).", - "title": "A human-friendly equivalent of the name.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated schedule." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 57 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated schedule." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n" - } - ] - }, - "flags": {}, - "id": 1914, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The cron expression used by this schedule." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1915, - "kind": 32768, - "kindString": "Parameter", - "name": "cron_expression", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "True if the schedule should be enabled." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1916, - "kind": 32768, - "kindString": "Parameter", - "name": "is_enabled", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1917, - "kind": 32768, - "kindString": "Parameter", - "name": "is_exclusive", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the schedule to create." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1918, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1919, - "kind": 32768, - "kindString": "Parameter", - "name": "actions", - "type": { - "name": "list[dict[str, Any]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Description of this schedule." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1920, - "kind": 32768, - "kindString": "Parameter", - "name": "description", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1921, - "kind": 32768, - "kindString": "Parameter", - "name": "timezone", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A human-friendly equivalent of the name." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1922, - "kind": 32768, - "kindString": "Parameter", - "name": "title", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1923, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Schedule", - "type": "reference", - "target": "1115" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1924, - "module": "_resource_clients.schedule", - "name": "delete", - "parsedDocstring": { - "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 103 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule\n" - } - ] - }, - "flags": {}, - "id": 1925, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1926, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1927, - "module": "_resource_clients.schedule", - "name": "get_log", - "parsedDocstring": { - "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "Retrieved log of the given schedule." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 113 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Retrieved log of the given schedule." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n" - } - ] - }, - "flags": {}, - "id": 1928, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_log", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1929, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ScheduleInvoked", - "target": "1141" - } - ], - "target": "2199" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3991, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific schedule.\n\nProvides methods to manage a specific schedule, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1905, - 1924, - 1910, - 1927, - 1913 - ], - "title": "Methods" - }, - { - "children": [ - 3991 - ], - "title": "Properties" - } - ], - "id": 1904, - "module": "_resource_clients.schedule", - "name": "ScheduleClient", - "parsedDocstring": { - "text": "Sub-client for managing a specific schedule.\n\nProvides methods to manage a specific schedule, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 21 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1931, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 145 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1936, - "module": "_resource_clients.schedule", - "name": "get", - "parsedDocstring": { - "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved schedule." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 158 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved schedule." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n" - } - ] - }, - "flags": {}, - "id": 1937, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1938, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Schedule | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Schedule", - "target": "1115" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1939, - "module": "_resource_clients.schedule", - "name": "update", - "parsedDocstring": { - "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n", - "args": { - "cron_expression": "The cron expression used by this schedule.", - "is_enabled": "True if the schedule should be enabled.", - "is_exclusive": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule.", - "name": "The name of the schedule to create.", - "actions": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure.", - "description": "Description of this schedule.", - "timezone": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones).", - "title": "A human-friendly equivalent of the name.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated schedule." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 174 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated schedule." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n" - } - ] - }, - "flags": {}, - "id": 1940, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The cron expression used by this schedule." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1941, - "kind": 32768, - "kindString": "Parameter", - "name": "cron_expression", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "True if the schedule should be enabled." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1942, - "kind": 32768, - "kindString": "Parameter", - "name": "is_enabled", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1943, - "kind": 32768, - "kindString": "Parameter", - "name": "is_exclusive", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the schedule to create." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1944, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1945, - "kind": 32768, - "kindString": "Parameter", - "name": "actions", - "type": { - "name": "list[dict[str, Any]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Description of this schedule." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1946, - "kind": 32768, - "kindString": "Parameter", - "name": "description", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1947, - "kind": 32768, - "kindString": "Parameter", - "name": "timezone", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A human-friendly equivalent of the name." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1948, - "kind": 32768, - "kindString": "Parameter", - "name": "title", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1949, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Schedule", - "type": "reference", - "target": "1115" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1950, - "module": "_resource_clients.schedule", - "name": "delete", - "parsedDocstring": { - "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 220 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule\n" - } - ] - }, - "flags": {}, - "id": 1951, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1952, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1953, - "module": "_resource_clients.schedule", - "name": "get_log", - "parsedDocstring": { - "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "Retrieved log of the given schedule." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 230 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Retrieved log of the given schedule." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n" - } - ] - }, - "flags": {}, - "id": 1954, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_log", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1955, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ScheduleInvoked", - "target": "1141" - } - ], - "target": "2199" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3964, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific schedule.\n\nProvides methods to manage a specific schedule, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1931, - 1950, - 1936, - 1953, - 1939 - ], - "title": "Methods" - }, - { - "children": [ - 3964 - ], - "title": "Properties" - } - ], - "id": 1930, - "module": "_resource_clients.schedule", - "name": "ScheduleClientAsync", - "parsedDocstring": { - "text": "Sub-client for managing a specific schedule.\n\nProvides methods to manage a specific schedule, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 138 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1957, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/user.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 33 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1962, - "module": "_resource_clients.user", - "name": "get", - "parsedDocstring": { - "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved user data, or None if the user does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/user.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 46 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved user data, or None if the user does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n" - } - ] - }, - "flags": {}, - "id": 1963, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1964, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "UserPublicInfo | UserPrivateInfo | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "UserPublicInfo", - "target": "1325" - }, - { - "type": "reference", - "name": "UserPrivateInfo", - "target": "1314" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1965, - "module": "_resource_clients.user", - "name": "monthly_usage", - "parsedDocstring": { - "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved monthly usage." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/user.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 67 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved monthly usage." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n" - } - ] - }, - "flags": {}, - "id": 1966, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "monthly_usage", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1967, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "MonthlyUsage", - "type": "reference", - "target": "736" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/users/account-limits/get-account-limits\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1968, - "module": "_resource_clients.user", - "name": "limits", - "parsedDocstring": { - "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/users/account-limits/get-account-limits\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The account limits." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/user.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 94 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The account limits." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/users/account-limits/get-account-limits\n" - } - ] - }, - "flags": {}, - "id": 1969, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "limits", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1970, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AccountLimits", - "type": "reference", - "target": "187" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the account's limits manageable on your account's Limits page.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1971, - "module": "_resource_clients.user", - "name": "update_limits", - "parsedDocstring": { - "text": "Update the account's limits manageable on your account's Limits page.\n", - "args": { - "max_monthly_usage_usd": "Maximum monthly usage in USD.", - "data_retention_days": "Data retention period in days.", - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/user.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 120 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the account's limits manageable on your account's Limits page.\n" - } - ] - }, - "flags": {}, - "id": 1972, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "update_limits", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum monthly usage in USD." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1973, - "kind": 32768, - "kindString": "Parameter", - "name": "max_monthly_usage_usd", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Data retention period in days." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1974, - "kind": 32768, - "kindString": "Parameter", - "name": "data_retention_days", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1975, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3992, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing user account information.\n\nProvides methods to manage user account information, e.g. get user data or monthly usage. Obtain an instance via\nan appropriate method on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1957, - 1962, - 1968, - 1965, - 1971 - ], - "title": "Methods" - }, - { - "children": [ - 3992 - ], - "title": "Properties" - } - ], - "id": 1956, - "module": "_resource_clients.user", - "name": "UserClient", - "parsedDocstring": { - "text": "Sub-client for managing user account information.\n\nProvides methods to manage user account information, e.g. get user data or monthly usage. Obtain an instance via\nan appropriate method on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/user.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 26 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1977, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/user.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 156 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1982, - "module": "_resource_clients.user", - "name": "get", - "parsedDocstring": { - "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved user data, or None if the user does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/user.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 169 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved user data, or None if the user does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n" - } - ] - }, - "flags": {}, - "id": 1983, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1984, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "UserPublicInfo | UserPrivateInfo | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "UserPublicInfo", - "target": "1325" - }, - { - "type": "reference", - "name": "UserPrivateInfo", - "target": "1314" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1985, - "module": "_resource_clients.user", - "name": "monthly_usage", - "parsedDocstring": { - "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved monthly usage." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/user.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 190 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved monthly usage." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n" - } - ] - }, - "flags": {}, - "id": 1986, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "monthly_usage", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1987, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "MonthlyUsage", - "type": "reference", - "target": "736" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/users/account-limits/get-account-limits\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1988, - "module": "_resource_clients.user", - "name": "limits", - "parsedDocstring": { - "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/users/account-limits/get-account-limits\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The account limits." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/user.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 217 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The account limits." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/users/account-limits/get-account-limits\n" - } - ] - }, - "flags": {}, - "id": 1989, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "limits", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1990, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AccountLimits", - "type": "reference", - "target": "187" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the account's limits manageable on your account's Limits page.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1991, - "module": "_resource_clients.user", - "name": "update_limits", - "parsedDocstring": { - "text": "Update the account's limits manageable on your account's Limits page.\n", - "args": { - "max_monthly_usage_usd": "Maximum monthly usage in USD.", - "data_retention_days": "Data retention period in days.", - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/user.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 243 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the account's limits manageable on your account's Limits page.\n" - } - ] - }, - "flags": {}, - "id": 1992, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "update_limits", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum monthly usage in USD." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1993, - "kind": 32768, - "kindString": "Parameter", - "name": "max_monthly_usage_usd", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Data retention period in days." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1994, - "kind": 32768, - "kindString": "Parameter", - "name": "data_retention_days", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1995, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3965, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing user account information.\n\nProvides methods to manage user account information, e.g. get user data or monthly usage. Obtain an instance via\nan appropriate method on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1977, - 1982, - 1988, - 1985, - 1991 - ], - "title": "Methods" - }, - { - "children": [ - 3965 - ], - "title": "Properties" - } - ], - "id": 1976, - "module": "_resource_clients.user", - "name": "UserClientAsync", - "parsedDocstring": { - "text": "Sub-client for managing user account information.\n\nProvides methods to manage user account information, e.g. get user data or monthly usage. Obtain an instance via\nan appropriate method on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/user.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 149 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize a new instance.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 1997, - "module": "_resource_clients.request_queue", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize a new instance.\n", - "args": { - "client_key": "A unique identifier of the client accessing the request queue." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 70 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize a new instance.\n" - } - ] - }, - "flags": {}, - "id": 1998, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 1999, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "'request-queues'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2000, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier of the client accessing the request queue." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2001, - "kind": 32768, - "kindString": "Parameter", - "name": "client_key", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2002, - "kind": 32768, - "kindString": "Parameter", - "name": "kwargs", - "type": { - "name": "Any", - "type": "reference" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2003, - "module": "_resource_clients.request_queue", - "name": "get", - "parsedDocstring": { - "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved request queue, or None, if it does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 90 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved request queue, or None, if it does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n" - } - ] - }, - "flags": {}, - "id": 2004, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2005, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "RequestQueue | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestQueue", - "target": "898" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2006, - "module": "_resource_clients.request_queue", - "name": "update", - "parsedDocstring": { - "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n", - "args": { - "name": "The new name for the request queue.", - "general_access": "Determines how others can access the request queue.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 106 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated request queue." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n" - } - ] - }, - "flags": {}, - "id": 2007, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new name for the request queue." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2008, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines how others can access the request queue." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2009, - "kind": 32768, - "kindString": "Parameter", - "name": "general_access", - "type": { - "name": "GeneralAccess | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "GeneralAccess", - "target": "1797" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2010, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "RequestQueue", - "type": "reference", - "target": "898" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2011, - "module": "_resource_clients.request_queue", - "name": "delete", - "parsedDocstring": { - "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 128 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue\n" - } - ] - }, - "flags": {}, - "id": 2012, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2013, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2014, - "module": "_resource_clients.request_queue", - "name": "list_head", - "parsedDocstring": { - "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n", - "args": { - "limit": "How many requests to retrieve.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The desired number of requests from the beginning of the queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 138 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The desired number of requests from the beginning of the queue." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n" - } - ] - }, - "flags": {}, - "id": 2015, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "list_head", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many requests to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2016, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2017, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "RequestQueueHead", - "type": "reference", - "target": "913" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2018, - "module": "_resource_clients.request_queue", - "name": "list_and_lock_head", - "parsedDocstring": { - "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n", - "args": { - "lock_duration": "How long the requests will be locked for.", - "limit": "How many requests to retrieve.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The desired number of locked requests from the beginning of the queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 162 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The desired number of locked requests from the beginning of the queue." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n" - } - ] - }, - "flags": {}, - "id": 2019, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "list_and_lock_head", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How long the requests will be locked for." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 2020, - "kind": 32768, - "kindString": "Parameter", - "name": "lock_duration", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many requests to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2021, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2022, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "LockedRequestQueueHead", - "type": "reference", - "target": "721" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2023, - "module": "_resource_clients.request_queue", - "name": "add_request", - "parsedDocstring": { - "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n", - "args": { - "request": "The request to add to the queue.", - "forefront": "Whether to add the request to the head or the end of the queue.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The added request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 197 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The added request." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n" - } - ] - }, - "flags": {}, - "id": 2024, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "add_request", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The request to add to the queue." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2025, - "kind": 32768, - "kindString": "Parameter", - "name": "request", - "type": { - "name": "RequestDraftDict | RequestDraftCamelDict | RequestDraft", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestDraftDict", - "target": "106" - }, - { - "type": "reference", - "name": "RequestDraftCamelDict", - "target": "111" - } - ] - }, - { - "type": "reference", - "name": "RequestDraft", - "target": "879" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to add the request to the head or the end of the queue." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2026, - "kind": 32768, - "kindString": "Parameter", - "name": "forefront", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2027, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "RequestRegistration", - "type": "reference", - "target": "948" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2028, - "module": "_resource_clients.request_queue", - "name": "get_request", - "parsedDocstring": { - "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n", - "args": { - "request_id": "ID of the request to retrieve.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved request, or None, if it did not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 232 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved request, or None, if it did not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n" - } - ] - }, - "flags": {}, - "id": 2029, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_request", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the request to retrieve." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2030, - "kind": 32768, - "kindString": "Parameter", - "name": "request_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2031, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Request | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Request", - "target": "876" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2032, - "module": "_resource_clients.request_queue", - "name": "update_request", - "parsedDocstring": { - "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n", - "args": { - "request": "The updated request.", - "forefront": "Whether to put the updated request in the beginning or the end of the queue.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 259 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated request." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n" - } - ] - }, - "flags": {}, - "id": 2033, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "update_request", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The updated request." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2034, - "kind": 32768, - "kindString": "Parameter", - "name": "request", - "type": { - "name": "RequestDict | RequestCamelDict | Request", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestDict", - "target": "102" - }, - { - "type": "reference", - "name": "RequestCamelDict", - "target": "104" - } - ] - }, - { - "type": "reference", - "name": "Request", - "target": "876" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to put the updated request in the beginning or the end of the queue." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2035, - "kind": 32768, - "kindString": "Parameter", - "name": "forefront", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2036, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "RequestRegistration", - "type": "reference", - "target": "948" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2037, - "module": "_resource_clients.request_queue", - "name": "delete_request", - "parsedDocstring": { - "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n", - "args": { - "request_id": "ID of the request to delete.", - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 294 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n" - } - ] - }, - "flags": {}, - "id": 2038, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "delete_request", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the request to delete." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2039, - "kind": 32768, - "kindString": "Parameter", - "name": "request_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2040, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2041, - "module": "_resource_clients.request_queue", - "name": "prolong_request_lock", - "parsedDocstring": { - "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n", - "args": { - "request_id": "ID of the request to prolong the lock.", - "forefront": "Whether to put the request in the beginning or the end of the queue after lock expires.", - "lock_duration": "By how much to prolong the lock.", - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 314 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n" - } - ] - }, - "flags": {}, - "id": 2042, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "prolong_request_lock", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the request to prolong the lock." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2043, - "kind": 32768, - "kindString": "Parameter", - "name": "request_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to put the request in the beginning or the end of the queue after lock expires." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2044, - "kind": 32768, - "kindString": "Parameter", - "name": "forefront", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "By how much to prolong the lock." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 2045, - "kind": 32768, - "kindString": "Parameter", - "name": "lock_duration", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2046, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "RequestLockInfo | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestLockInfo", - "target": "895" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2047, - "module": "_resource_clients.request_queue", - "name": "delete_request_lock", - "parsedDocstring": { - "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n", - "args": { - "request_id": "ID of the request to delete the lock.", - "forefront": "Whether to put the request in the beginning or the end of the queue after the lock is deleted.", - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 348 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n" - } - ] - }, - "flags": {}, - "id": 2048, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "delete_request_lock", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the request to delete the lock." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2049, - "kind": 32768, - "kindString": "Parameter", - "name": "request_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to put the request in the beginning or the end of the queue after the lock is deleted." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2050, - "kind": 32768, - "kindString": "Parameter", - "name": "forefront", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2051, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2052, - "module": "_resource_clients.request_queue", - "name": "batch_add_requests", - "parsedDocstring": { - "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n", - "args": { - "requests": "List of requests to be added to the queue.", - "forefront": "Whether to add requests to the front of the queue.", - "max_parallel": "Specifies the maximum number of parallel tasks for API calls. This is only applicable\nto the async client. For the sync client, this value must be set to 1, as parallel execution\nis not supported.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "Result containing lists of processed and unprocessed requests." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 373 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Result containing lists of processed and unprocessed requests." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n" - } - ] - }, - "flags": {}, - "id": 2053, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "batch_add_requests", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of requests to be added to the queue." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2054, - "kind": 32768, - "kindString": "Parameter", - "name": "requests", - "type": { - "name": "list[RequestDraft] | list[RequestDraftDict] | list[RequestDraftCamelDict]", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "RequestDraft", - "target": "879" - } - ], - "target": "2199" - }, - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "RequestDraftDict", - "target": "106" - } - ], - "target": "2199" - } - ] - }, - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "RequestDraftCamelDict", - "target": "111" - } - ], - "target": "2199" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to add requests to the front of the queue." - } - ] - }, - "defaultValue": "False", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2055, - "kind": 32768, - "kindString": "Parameter", - "name": "forefront", - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the maximum number of parallel tasks for API calls. This is only applicable\nto the async client. For the sync client, this value must be set to 1, as parallel execution\nis not supported." - } - ] - }, - "defaultValue": "1", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2056, - "kind": 32768, - "kindString": "Parameter", - "name": "max_parallel", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2057, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "BatchAddResult", - "type": "reference", - "target": "287" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2058, - "module": "_resource_clients.request_queue", - "name": "batch_delete_requests", - "parsedDocstring": { - "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n", - "args": { - "requests": "List of the requests to delete.", - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 454 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n" - } - ] - }, - "flags": {}, - "id": 2059, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "batch_delete_requests", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of the requests to delete." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2060, - "kind": 32768, - "kindString": "Parameter", - "name": "requests", - "type": { - "name": "list[RequestDraftDelete] | list[RequestDraftDeleteDict] | list[RequestDraftDeleteCamelDict]", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "RequestDraftDelete", - "target": "893" - } - ], - "target": "2199" - }, - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "RequestDraftDeleteByIdDict | RequestDraftDeleteByUniqueKeyDict" - } - ], - "target": "2199" - } - ] - }, - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "RequestDraftDeleteByIdCamelDict | RequestDraftDeleteByUniqueKeyCamelDict" - } - ], - "target": "2199" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2061, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "BatchDeleteResult", - "type": "reference", - "target": "294" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2062, - "module": "_resource_clients.request_queue", - "name": "list_requests", - "parsedDocstring": { - "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n", - "args": { - "limit": "How many requests to retrieve.", - "filter": "List of request states to use as a filter. Multiple values mean union of the given filters.", - "timeout": "Timeout for the API HTTP request.", - "cursor": "A token returned in previous API response, to continue listing next page of requests" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 492 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n" - } - ] - }, - "flags": {}, - "id": 2063, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "list_requests", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many requests to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2064, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of request states to use as a filter. Multiple values mean union of the given filters." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2065, - "kind": 32768, - "kindString": "Parameter", - "name": "filter", - "type": { - "name": "list[Literal['pending', 'locked']] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "pending" - }, - { - "type": "literal", - "value": "locked" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2066, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A token returned in previous API response, to continue listing next page of requests" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2067, - "kind": 32768, - "kindString": "Parameter", - "name": "cursor", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "ListOfRequests", - "type": "reference", - "target": "681" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over requests in the queue.\n\nSimple `list_requests` does only one API call, possibly not listing all items matching the criteria.\nThis method returns an iterator that is capable of making multiple API calls to retrieve all items\nmatching the criteria using the opaque `cursor` returned by the API.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2068, - "module": "_resource_clients.request_queue", - "name": "iterate_requests", - "parsedDocstring": { - "text": "Iterate over requests in the queue.\n\nSimple `list_requests` does only one API call, possibly not listing all items matching the criteria.\nThis method returns an iterator that is capable of making multiple API calls to retrieve all items\nmatching the criteria using the opaque `cursor` returned by the API.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n", - "args": { - "limit": "Maximum number of requests to yield across all pages.", - "filter": "List of request states to use as a filter. Multiple values mean union of the given filters.", - "cursor": "A token returned in a previous API response, used as the initial pagination cursor.", - "chunk_size": "Maximum number of requests requested per API call when iterating across pages.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 527 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over requests in the queue.\n\nSimple `list_requests` does only one API call, possibly not listing all items matching the criteria.\nThis method returns an iterator that is capable of making multiple API calls to retrieve all items\nmatching the criteria using the opaque `cursor` returned by the API.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n" - } - ] - }, - "flags": {}, - "id": 2069, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate_requests", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of requests to yield across all pages." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2070, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of request states to use as a filter. Multiple values mean union of the given filters." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2071, - "kind": 32768, - "kindString": "Parameter", - "name": "filter", - "type": { - "name": "list[Literal['pending', 'locked']] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "pending" - }, - { - "type": "literal", - "value": "locked" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A token returned in a previous API response, used as the initial pagination cursor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2072, - "kind": 32768, - "kindString": "Parameter", - "name": "cursor", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of requests requested per API call when iterating across pages." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2073, - "kind": 32768, - "kindString": "Parameter", - "name": "chunk_size", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2074, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Request", - "target": "876" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2075, - "module": "_resource_clients.request_queue", - "name": "unlock_requests", - "parsedDocstring": { - "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "Result of the unlock operation containing the count of unlocked requests" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 565 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Result of the unlock operation containing the count of unlocked requests" - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n" - } - ] - }, - "flags": {}, - "id": 2076, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "unlock_requests", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2077, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "UnlockRequestsResult", - "type": "reference", - "target": "1253" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3993, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific request queue.\n\nProvides methods to manage a specific request queue, e.g. update it, delete it, or manage its requests. Obtain an\ninstance via an appropriate method on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1997, - 2023, - 2052, - 2058, - 2011, - 2037, - 2047, - 2003, - 2028, - 2068, - 2018, - 2014, - 2062, - 2041, - 2075, - 2006, - 2032 - ], - "title": "Methods" - }, - { - "children": [ - 3993 - ], - "title": "Properties" - } - ], - "id": 1996, - "module": "_resource_clients.request_queue", - "name": "RequestQueueClient", - "parsedDocstring": { - "text": "Sub-client for managing a specific request queue.\n\nProvides methods to manage a specific request queue, e.g. update it, delete it, or manage its requests. Obtain an\ninstance via an appropriate method on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 63 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize a new instance.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2079, - "module": "_resource_clients.request_queue", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize a new instance.\n", - "args": { - "client_key": "A unique identifier of the client accessing the request queue." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 597 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize a new instance.\n" - } - ] - }, - "flags": {}, - "id": 2080, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2081, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "defaultValue": "'request-queues'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2082, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier of the client accessing the request queue." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2083, - "kind": 32768, - "kindString": "Parameter", - "name": "client_key", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2084, - "kind": 32768, - "kindString": "Parameter", - "name": "kwargs", - "type": { - "name": "Any", - "type": "reference" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2085, - "module": "_resource_clients.request_queue", - "name": "get", - "parsedDocstring": { - "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved request queue, or None, if it does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 617 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved request queue, or None, if it does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n" - } - ] - }, - "flags": {}, - "id": 2086, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2087, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "RequestQueue | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestQueue", - "target": "898" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2088, - "module": "_resource_clients.request_queue", - "name": "update", - "parsedDocstring": { - "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n", - "args": { - "name": "The new name for the request queue.", - "general_access": "Determines how others can access the request queue.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 633 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated request queue." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n" - } - ] - }, - "flags": {}, - "id": 2089, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new name for the request queue." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2090, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines how others can access the request queue." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2091, - "kind": 32768, - "kindString": "Parameter", - "name": "general_access", - "type": { - "name": "GeneralAccess | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "GeneralAccess", - "target": "1797" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2092, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "RequestQueue", - "type": "reference", - "target": "898" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2093, - "module": "_resource_clients.request_queue", - "name": "delete", - "parsedDocstring": { - "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 655 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue\n" - } - ] - }, - "flags": {}, - "id": 2094, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2095, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2096, - "module": "_resource_clients.request_queue", - "name": "list_head", - "parsedDocstring": { - "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n", - "args": { - "limit": "How many requests to retrieve.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The desired number of requests from the beginning of the queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 665 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The desired number of requests from the beginning of the queue." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n" - } - ] - }, - "flags": {}, - "id": 2097, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "list_head", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many requests to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2098, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2099, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "RequestQueueHead", - "type": "reference", - "target": "913" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2100, - "module": "_resource_clients.request_queue", - "name": "list_and_lock_head", - "parsedDocstring": { - "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n", - "args": { - "lock_duration": "How long the requests will be locked for.", - "limit": "How many requests to retrieve.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The desired number of locked requests from the beginning of the queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 689 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The desired number of locked requests from the beginning of the queue." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n" - } - ] - }, - "flags": {}, - "id": 2101, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "list_and_lock_head", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How long the requests will be locked for." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 2102, - "kind": 32768, - "kindString": "Parameter", - "name": "lock_duration", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many requests to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2103, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2104, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "LockedRequestQueueHead", - "type": "reference", - "target": "721" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2105, - "module": "_resource_clients.request_queue", - "name": "add_request", - "parsedDocstring": { - "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n", - "args": { - "request": "The request to add to the queue.", - "forefront": "Whether to add the request to the head or the end of the queue.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The added request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 724 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The added request." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n" - } - ] - }, - "flags": {}, - "id": 2106, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "add_request", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The request to add to the queue." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2107, - "kind": 32768, - "kindString": "Parameter", - "name": "request", - "type": { - "name": "RequestDraftDict | RequestDraftCamelDict | RequestDraft", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestDraftDict", - "target": "106" - }, - { - "type": "reference", - "name": "RequestDraftCamelDict", - "target": "111" - } - ] - }, - { - "type": "reference", - "name": "RequestDraft", - "target": "879" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to add the request to the head or the end of the queue." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2108, - "kind": 32768, - "kindString": "Parameter", - "name": "forefront", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2109, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "RequestRegistration", - "type": "reference", - "target": "948" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2110, - "module": "_resource_clients.request_queue", - "name": "get_request", - "parsedDocstring": { - "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n", - "args": { - "request_id": "ID of the request to retrieve.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved request, or None, if it did not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 759 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved request, or None, if it did not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n" - } - ] - }, - "flags": {}, - "id": 2111, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_request", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the request to retrieve." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2112, - "kind": 32768, - "kindString": "Parameter", - "name": "request_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2113, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Request | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Request", - "target": "876" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2114, - "module": "_resource_clients.request_queue", - "name": "update_request", - "parsedDocstring": { - "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n", - "args": { - "request": "The updated request.", - "forefront": "Whether to put the updated request in the beginning or the end of the queue.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 784 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated request." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n" - } - ] - }, - "flags": {}, - "id": 2115, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "update_request", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The updated request." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2116, - "kind": 32768, - "kindString": "Parameter", - "name": "request", - "type": { - "name": "RequestDict | RequestCamelDict | Request", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestDict", - "target": "102" - }, - { - "type": "reference", - "name": "RequestCamelDict", - "target": "104" - } - ] - }, - { - "type": "reference", - "name": "Request", - "target": "876" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to put the updated request in the beginning or the end of the queue." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2117, - "kind": 32768, - "kindString": "Parameter", - "name": "forefront", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2118, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "RequestRegistration", - "type": "reference", - "target": "948" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2119, - "module": "_resource_clients.request_queue", - "name": "delete_request", - "parsedDocstring": { - "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n", - "args": { - "request_id": "ID of the request to delete.", - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 819 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n" - } - ] - }, - "flags": {}, - "id": 2120, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "delete_request", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the request to delete." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2121, - "kind": 32768, - "kindString": "Parameter", - "name": "request_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2122, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2123, - "module": "_resource_clients.request_queue", - "name": "prolong_request_lock", - "parsedDocstring": { - "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n", - "args": { - "request_id": "ID of the request to prolong the lock.", - "forefront": "Whether to put the request in the beginning or the end of the queue after lock expires.", - "lock_duration": "By how much to prolong the lock.", - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 837 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n" - } - ] - }, - "flags": {}, - "id": 2124, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "prolong_request_lock", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the request to prolong the lock." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2125, - "kind": 32768, - "kindString": "Parameter", - "name": "request_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to put the request in the beginning or the end of the queue after lock expires." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2126, - "kind": 32768, - "kindString": "Parameter", - "name": "forefront", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "By how much to prolong the lock." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 2127, - "kind": 32768, - "kindString": "Parameter", - "name": "lock_duration", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2128, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "RequestLockInfo | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "RequestLockInfo", - "target": "895" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2129, - "module": "_resource_clients.request_queue", - "name": "delete_request_lock", - "parsedDocstring": { - "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n", - "args": { - "request_id": "ID of the request to delete the lock.", - "forefront": "Whether to put the request in the beginning or the end of the queue after the lock is deleted.", - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 871 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n" - } - ] - }, - "flags": {}, - "id": 2130, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "delete_request_lock", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the request to delete the lock." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2131, - "kind": 32768, - "kindString": "Parameter", - "name": "request_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to put the request in the beginning or the end of the queue after the lock is deleted." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2132, - "kind": 32768, - "kindString": "Parameter", - "name": "forefront", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2133, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2134, - "module": "_resource_clients.request_queue", - "name": "batch_add_requests", - "parsedDocstring": { - "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n", - "args": { - "requests": "List of requests to be added to the queue.", - "forefront": "Whether to add requests to the front of the queue.", - "max_parallel": "Specifies the maximum number of parallel tasks for API calls. This is only applicable\nto the async client. For the sync client, this value must be set to 1, as parallel execution\nis not supported.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "Result containing lists of processed and unprocessed requests." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 945 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Result containing lists of processed and unprocessed requests." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n" - } - ] - }, - "flags": {}, - "id": 2135, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "batch_add_requests", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of requests to be added to the queue." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2136, - "kind": 32768, - "kindString": "Parameter", - "name": "requests", - "type": { - "name": "list[RequestDraft] | list[RequestDraftDict] | list[RequestDraftCamelDict]", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "RequestDraft", - "target": "879" - } - ], - "target": "2199" - }, - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "RequestDraftDict", - "target": "106" - } - ], - "target": "2199" - } - ] - }, - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "RequestDraftCamelDict", - "target": "111" - } - ], - "target": "2199" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to add requests to the front of the queue." - } - ] - }, - "defaultValue": "False", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2137, - "kind": 32768, - "kindString": "Parameter", - "name": "forefront", - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the maximum number of parallel tasks for API calls. This is only applicable\nto the async client. For the sync client, this value must be set to 1, as parallel execution\nis not supported." - } - ] - }, - "defaultValue": "5", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2138, - "kind": 32768, - "kindString": "Parameter", - "name": "max_parallel", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2139, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "BatchAddResult", - "type": "reference", - "target": "287" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2140, - "module": "_resource_clients.request_queue", - "name": "batch_delete_requests", - "parsedDocstring": { - "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n", - "args": { - "requests": "List of the requests to delete.", - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1037 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n" - } - ] - }, - "flags": {}, - "id": 2141, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "batch_delete_requests", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of the requests to delete." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2142, - "kind": 32768, - "kindString": "Parameter", - "name": "requests", - "type": { - "name": "list[RequestDraftDelete] | list[RequestDraftDeleteDict] | list[RequestDraftDeleteCamelDict]", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "RequestDraftDelete", - "target": "893" - } - ], - "target": "2199" - }, - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "RequestDraftDeleteByIdDict | RequestDraftDeleteByUniqueKeyDict" - } - ], - "target": "2199" - } - ] - }, - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "RequestDraftDeleteByIdCamelDict | RequestDraftDeleteByUniqueKeyCamelDict" - } - ], - "target": "2199" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2143, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "BatchDeleteResult", - "type": "reference", - "target": "294" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2144, - "module": "_resource_clients.request_queue", - "name": "list_requests", - "parsedDocstring": { - "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n", - "args": { - "limit": "How many requests to retrieve.", - "filter": "List of request states to use as a filter. Multiple values mean union of the given filters.", - "timeout": "Timeout for the API HTTP request.", - "cursor": "A token returned in previous API response, to continue listing next page of requests" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1074 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n" - } - ] - }, - "flags": {}, - "id": 2145, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "list_requests", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many requests to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2146, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of request states to use as a filter. Multiple values mean union of the given filters." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2147, - "kind": 32768, - "kindString": "Parameter", - "name": "filter", - "type": { - "name": "list[Literal['pending', 'locked']] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "pending" - }, - { - "type": "literal", - "value": "locked" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2148, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A token returned in previous API response, to continue listing next page of requests" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2149, - "kind": 32768, - "kindString": "Parameter", - "name": "cursor", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "ListOfRequests", - "type": "reference", - "target": "681" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over requests in the queue.\n\nSimple `list_requests` does only one API call, possibly not listing all items matching the criteria.\nThis method returns an iterator that is capable of making multiple API calls to retrieve all items\nmatching the criteria using the opaque `cursor` returned by the API.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2150, - "module": "_resource_clients.request_queue", - "name": "iterate_requests", - "parsedDocstring": { - "text": "Iterate over requests in the queue.\n\nSimple `list_requests` does only one API call, possibly not listing all items matching the criteria.\nThis method returns an iterator that is capable of making multiple API calls to retrieve all items\nmatching the criteria using the opaque `cursor` returned by the API.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n", - "args": { - "limit": "Maximum number of requests to yield across all pages.", - "filter": "List of request states to use as a filter. Multiple values mean union of the given filters.", - "cursor": "A token returned in a previous API response, used as the initial pagination cursor.", - "chunk_size": "Maximum number of requests requested per API call when iterating across pages.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1109 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over requests in the queue.\n\nSimple `list_requests` does only one API call, possibly not listing all items matching the criteria.\nThis method returns an iterator that is capable of making multiple API calls to retrieve all items\nmatching the criteria using the opaque `cursor` returned by the API.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n" - } - ] - }, - "flags": {}, - "id": 2151, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate_requests", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of requests to yield across all pages." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2152, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of request states to use as a filter. Multiple values mean union of the given filters." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2153, - "kind": 32768, - "kindString": "Parameter", - "name": "filter", - "type": { - "name": "list[Literal['pending', 'locked']] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "pending" - }, - { - "type": "literal", - "value": "locked" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A token returned in a previous API response, used as the initial pagination cursor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2154, - "kind": 32768, - "kindString": "Parameter", - "name": "cursor", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of requests requested per API call when iterating across pages." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2155, - "kind": 32768, - "kindString": "Parameter", - "name": "chunk_size", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2156, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Request", - "target": "876" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2157, - "module": "_resource_clients.request_queue", - "name": "unlock_requests", - "parsedDocstring": { - "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "Result of the unlock operation containing the count of unlocked requests" - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1147 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Result of the unlock operation containing the count of unlocked requests" - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n" - } - ] - }, - "flags": {}, - "id": 2158, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "unlock_requests", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2159, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "UnlockRequestsResult", - "type": "reference", - "target": "1253" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3966, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific request queue.\n\nProvides methods to manage a specific request queue, e.g. update it, delete it, or manage its requests. Obtain an\ninstance via an appropriate method on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2079, - 2105, - 2134, - 2140, - 2093, - 2119, - 2129, - 2085, - 2110, - 2150, - 2100, - 2096, - 2144, - 2123, - 2157, - 2088, - 2114 - ], - "title": "Methods" - }, - { - "children": [ - 3966 - ], - "title": "Properties" - } - ], - "id": 2078, - "module": "_resource_clients.request_queue", - "name": "RequestQueueClientAsync", - "parsedDocstring": { - "text": "Sub-client for managing a specific request queue.\n\nProvides methods to manage a specific request queue, e.g. update it, delete it, or manage its requests. Obtain an\ninstance via an appropriate method on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 590 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2161, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 26 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n404s collapse to `None` only when this client targets a specific log by ID (e.g. `client.log(run_id).get()`).\nFor chained clients without a `resource_id` (e.g. `run.log().get()`), a 404 is ambiguous and propagates.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2165, - "module": "_resource_clients.log", - "name": "get", - "parsedDocstring": { - "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n404s collapse to `None` only when this client targets a specific log by ID (e.g. `client.log(run_id).get()`).\nFor chained clients without a `resource_id` (e.g. `run.log().get()`), a 404 is ambiguous and propagates.\n", - "args": { - "raw": "If true, the log will include formatting. For example, coloring character sequences.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved log, or None, if it does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 37 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved log, or None, if it does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n404s collapse to `None` only when this client targets a specific log by ID (e.g. `client.log(run_id).get()`).\nFor chained clients without a `resource_id` (e.g. `run.log().get()`), a 404 is ambiguous and propagates.\n" - } - ] - }, - "flags": {}, - "id": 2166, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the log will include formatting. For example, coloring character sequences." - } - ] - }, - "defaultValue": "False", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2167, - "kind": 32768, - "kindString": "Parameter", - "name": "raw", - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2168, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2169, - "module": "_resource_clients.log", - "name": "get_as_bytes", - "parsedDocstring": { - "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n", - "args": { - "raw": "If true, the log will include formatting. For example, coloring character sequences.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved log as raw bytes, or None, if it does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 67 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved log as raw bytes, or None, if it does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n" - } - ] - }, - "flags": {}, - "id": 2170, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_as_bytes", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the log will include formatting. For example, coloring character sequences." - } - ] - }, - "defaultValue": "False", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2171, - "kind": 32768, - "kindString": "Parameter", - "name": "raw", - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2172, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "bytes | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bytes" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n" - } - ] - }, - "decorations": [ - { - "name": "contextmanager" - } - ], - "flags": {}, - "groups": [], - "id": 2173, - "module": "_resource_clients.log", - "name": "stream", - "parsedDocstring": { - "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n", - "args": { - "raw": "If true, the log will include formatting. For example, coloring character sequences.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved log as a context-managed streaming `Response`, or None, if it does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 95 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved log as a context-managed streaming `Response`, or None, if it does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n" - } - ] - }, - "flags": {}, - "id": 2174, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "stream", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the log will include formatting. For example, coloring character sequences." - } - ] - }, - "defaultValue": "False", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2175, - "kind": 32768, - "kindString": "Parameter", - "name": "raw", - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2176, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "HttpResponse", - "target": "1805" - }, - { - "type": "literal", - "value": null - } - ] - } - ] - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3994, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific log.\n\nProvides methods to manage logs, e.g. get or stream them. Obtain an instance via an appropriate method on the\n`ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2161, - 2165, - 2169, - 2173 - ], - "title": "Methods" - }, - { - "children": [ - 3994 - ], - "title": "Properties" - } - ], - "id": 2160, - "module": "_resource_clients.log", - "name": "LogClient", - "parsedDocstring": { - "text": "Sub-client for managing a specific log.\n\nProvides methods to manage logs, e.g. get or stream them. Obtain an instance via an appropriate method on the\n`ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 19 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2178, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 134 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n404s collapse to `None` only when this client targets a specific log by ID (e.g. `client.log(run_id).get()`).\nFor chained clients without a `resource_id` (e.g. `run.log().get()`), a 404 is ambiguous and propagates.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2182, - "module": "_resource_clients.log", - "name": "get", - "parsedDocstring": { - "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n404s collapse to `None` only when this client targets a specific log by ID (e.g. `client.log(run_id).get()`).\nFor chained clients without a `resource_id` (e.g. `run.log().get()`), a 404 is ambiguous and propagates.\n", - "args": { - "raw": "If true, the log will include formatting. For example, coloring character sequences.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved log, or None, if it does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 145 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved log, or None, if it does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n404s collapse to `None` only when this client targets a specific log by ID (e.g. `client.log(run_id).get()`).\nFor chained clients without a `resource_id` (e.g. `run.log().get()`), a 404 is ambiguous and propagates.\n" - } - ] - }, - "flags": {}, - "id": 2183, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the log will include formatting. For example, coloring character sequences." - } - ] - }, - "defaultValue": "False", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2184, - "kind": 32768, - "kindString": "Parameter", - "name": "raw", - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2185, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2186, - "module": "_resource_clients.log", - "name": "get_as_bytes", - "parsedDocstring": { - "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n", - "args": { - "raw": "If true, the log will include formatting. For example, coloring character sequences.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved log as raw bytes, or None, if it does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 175 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved log as raw bytes, or None, if it does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n" - } - ] - }, - "flags": {}, - "id": 2187, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_as_bytes", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the log will include formatting. For example, coloring character sequences." - } - ] - }, - "defaultValue": "False", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2188, - "kind": 32768, - "kindString": "Parameter", - "name": "raw", - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2189, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "bytes | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bytes" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n" - } - ] - }, - "decorations": [ - { - "name": "asynccontextmanager" - } - ], - "flags": {}, - "groups": [], - "id": 2190, - "module": "_resource_clients.log", - "name": "stream", - "parsedDocstring": { - "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n", - "args": { - "raw": "If true, the log will include formatting. For example, coloring character sequences.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved log as a context-managed streaming `Response`, or None, if it does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 203 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved log as a context-managed streaming `Response`, or None, if it does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n" - } - ] - }, - "flags": {}, - "id": 2191, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "stream", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the log will include formatting. For example, coloring character sequences." - } - ] - }, - "defaultValue": "False", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2192, - "kind": 32768, - "kindString": "Parameter", - "name": "raw", - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2193, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "HttpResponse", - "target": "1805" - }, - { - "type": "literal", - "value": null - } - ] - } - ] - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3967, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific log.\n\nProvides methods to manage logs, e.g. get or stream them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2178, - 2182, - 2186, - 2190 - ], - "title": "Methods" - }, - { - "children": [ - 3967 - ], - "title": "Properties" - } - ], - "id": 2177, - "module": "_resource_clients.log", - "name": "LogClientAsync", - "parsedDocstring": { - "text": "Sub-client for managing a specific log.\n\nProvides methods to manage logs, e.g. get or stream them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/log.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 127 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2195, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 23 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the available Actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2199, - "module": "_resource_clients.actor_env_var_collection", - "name": "list", - "parsedDocstring": { - "text": "List the available Actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available Actor environment variables." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 34 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available Actor environment variables." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the available Actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n" - } - ] - }, - "flags": {}, - "id": 2200, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2201, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfEnvVars", - "type": "reference", - "target": "657" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available Actor environment variables.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to define more\nenvironment variables than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2202, - "module": "_resource_clients.actor_env_var_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over the available Actor environment variables.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to define more\nenvironment variables than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 48 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available Actor environment variables.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to define more\nenvironment variables than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n" - } - ] - }, - "flags": {}, - "id": 2203, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2204, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "EnvVar", - "target": "541" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2205, - "module": "_resource_clients.actor_env_var_collection", - "name": "create", - "parsedDocstring": { - "text": "Create a new Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n", - "args": { - "is_secret": "Whether the environment variable is secret or not.", - "name": "The name of the environment variable.", - "value": "The value of the environment variable.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The created Actor environment variable." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 66 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The created Actor environment variable." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create a new Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n" - } - ] - }, - "flags": {}, - "id": 2206, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "create", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the environment variable is secret or not." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2207, - "kind": 32768, - "kindString": "Parameter", - "name": "is_secret", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the environment variable." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 2208, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value of the environment variable." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 2209, - "kind": 32768, - "kindString": "Parameter", - "name": "value", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2210, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "EnvVar", - "type": "reference", - "target": "541" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3995, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the Actor environment variable collection.\n\nProvides methods to manage Actor environment variables, e.g. list or create them. Obtain an instance via an\nappropriate method on the `ActorVersionClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2195, - 2205, - 2202, - 2199 - ], - "title": "Methods" - }, - { - "children": [ - 3995 - ], - "title": "Properties" - } - ], - "id": 2194, - "module": "_resource_clients.actor_env_var_collection", - "name": "ActorEnvVarCollectionClient", - "parsedDocstring": { - "text": "Sub-client for the Actor environment variable collection.\n\nProvides methods to manage Actor environment variables, e.g. list or create them. Obtain an instance via an\nappropriate method on the `ActorVersionClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 16 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2212, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 102 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the available Actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2216, - "module": "_resource_clients.actor_env_var_collection", - "name": "list", - "parsedDocstring": { - "text": "List the available Actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available Actor environment variables." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 113 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available Actor environment variables." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the available Actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n" - } - ] - }, - "flags": {}, - "id": 2217, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2218, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfEnvVars", - "type": "reference", - "target": "657" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available Actor environment variables.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to define more\nenvironment variables than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2219, - "module": "_resource_clients.actor_env_var_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over the available Actor environment variables.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to define more\nenvironment variables than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 127 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available Actor environment variables.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to define more\nenvironment variables than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n" - } - ] - }, - "flags": {}, - "id": 2220, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2221, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "EnvVar", - "target": "541" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2222, - "module": "_resource_clients.actor_env_var_collection", - "name": "create", - "parsedDocstring": { - "text": "Create a new Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n", - "args": { - "is_secret": "Whether the environment variable is secret or not.", - "name": "The name of the environment variable.", - "value": "The value of the environment variable.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The created Actor environment variable." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 146 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The created Actor environment variable." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create a new Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n" - } - ] - }, - "flags": {}, - "id": 2223, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "create", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the environment variable is secret or not." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2224, - "kind": 32768, - "kindString": "Parameter", - "name": "is_secret", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the environment variable." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 2225, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value of the environment variable." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 2226, - "kind": 32768, - "kindString": "Parameter", - "name": "value", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2227, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "EnvVar", - "type": "reference", - "target": "541" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3968, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the Actor environment variable collection.\n\nProvides methods to manage Actor environment variables, e.g. list or create them. Obtain an instance via an\nappropriate method on the `ActorVersionClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2212, - 2222, - 2219, - 2216 - ], - "title": "Methods" - }, - { - "children": [ - 3968 - ], - "title": "Properties" - } - ], - "id": 2211, - "module": "_resource_clients.actor_env_var_collection", - "name": "ActorEnvVarCollectionClientAsync", - "parsedDocstring": { - "text": "Sub-client for the Actor environment variable collection.\n\nProvides methods to manage Actor environment variables, e.g. list or create them. Obtain an instance via an\nappropriate method on the `ActorVersionClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 95 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2229, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 25 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2233, - "module": "_resource_clients.webhook_dispatch_collection", - "name": "list", - "parsedDocstring": { - "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n", - "args": { - "limit": "How many webhook dispatches to retrieve.", - "offset": "What webhook dispatch to include as first when retrieving the list.", - "desc": "Whether to sort the webhook dispatches in descending order based on the date of their creation.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved webhook dispatches of a user." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 36 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved webhook dispatches of a user." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n" - } - ] - }, - "flags": {}, - "id": 2234, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many webhook dispatches to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2235, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What webhook dispatch to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2236, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the webhook dispatches in descending order based on the date of their creation." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2237, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2238, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfWebhookDispatches", - "type": "reference", - "target": "780" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over all webhook dispatches of a user.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2239, - "module": "_resource_clients.webhook_dispatch_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over all webhook dispatches of a user.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n", - "args": { - "limit": "How many webhook dispatches to retrieve.", - "offset": "What webhook dispatch to include as first when retrieving the list.", - "desc": "Whether to sort the webhook dispatches in descending order based on the date of their creation.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 60 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over all webhook dispatches of a user.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n" - } - ] - }, - "flags": {}, - "id": 2240, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many webhook dispatches to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2241, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What webhook dispatch to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2242, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the webhook dispatches in descending order based on the date of their creation." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2243, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2244, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookDispatch", - "target": "1386" - } - ] - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3996, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the webhook dispatch collection.\n\nProvides methods to manage webhook dispatches, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2229, - 2239, - 2233 - ], - "title": "Methods" - }, - { - "children": [ - 3996 - ], - "title": "Properties" - } - ], - "id": 2228, - "module": "_resource_clients.webhook_dispatch_collection", - "name": "WebhookDispatchCollectionClient", - "parsedDocstring": { - "text": "Sub-client for the webhook dispatch collection.\n\nProvides methods to manage webhook dispatches, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 18 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2246, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 99 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2250, - "module": "_resource_clients.webhook_dispatch_collection", - "name": "list", - "parsedDocstring": { - "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n", - "args": { - "limit": "How many webhook dispatches to retrieve.", - "offset": "What webhook dispatch to include as first when retrieving the list.", - "desc": "Whether to sort the webhook dispatches in descending order based on the date of their creation.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved webhook dispatches of a user." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 110 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved webhook dispatches of a user." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n" - } - ] - }, - "flags": {}, - "id": 2251, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many webhook dispatches to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2252, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What webhook dispatch to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2253, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the webhook dispatches in descending order based on the date of their creation." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2254, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2255, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfWebhookDispatches", - "type": "reference", - "target": "780" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over all webhook dispatches of a user.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2256, - "module": "_resource_clients.webhook_dispatch_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over all webhook dispatches of a user.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n", - "args": { - "limit": "How many webhook dispatches to retrieve.", - "offset": "What webhook dispatch to include as first when retrieving the list.", - "desc": "Whether to sort the webhook dispatches in descending order based on the date of their creation.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 134 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over all webhook dispatches of a user.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n" - } - ] - }, - "flags": {}, - "id": 2257, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many webhook dispatches to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2258, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What webhook dispatch to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2259, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the webhook dispatches in descending order based on the date of their creation." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2260, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2261, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookDispatch", - "target": "1386" - } - ] - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3969, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the webhook dispatch collection.\n\nProvides methods to manage webhook dispatches, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2246, - 2256, - 2250 - ], - "title": "Methods" - }, - { - "children": [ - 3969 - ], - "title": "Properties" - } - ], - "id": 2245, - "module": "_resource_clients.webhook_dispatch_collection", - "name": "WebhookDispatchCollectionClientAsync", - "parsedDocstring": { - "text": "Sub-client for the webhook dispatch collection.\n\nProvides methods to manage webhook dispatches, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 92 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2263, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 36 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2267, - "module": "_resource_clients.actor_collection", - "name": "list", - "parsedDocstring": { - "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n", - "args": { - "my": "If True, will return only Actors which the user has created themselves.", - "limit": "How many Actors to list.", - "offset": "What Actor to include as first when retrieving the list.", - "desc": "Whether to sort the Actors in descending order based on their creation date.", - "sort_by": "Field to sort the results by.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available Actors matching the specified filters." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 47 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available Actors matching the specified filters." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n" - } - ] - }, - "flags": {}, - "id": 2268, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, will return only Actors which the user has created themselves." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2269, - "kind": 32768, - "kindString": "Parameter", - "name": "my", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many Actors to list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2270, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What Actor to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2271, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the Actors in descending order based on their creation date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2272, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Field to sort the results by." - } - ] - }, - "defaultValue": "'createdAt'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2273, - "kind": 32768, - "kindString": "Parameter", - "name": "sort_by", - "type": { - "name": "Literal['createdAt', 'stats.lastRunStartedAt'] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "createdAt" - }, - { - "type": "literal", - "value": "stats.lastRunStartedAt" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2274, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfActors", - "type": "reference", - "target": "753" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the Actors the user has created or used.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2275, - "module": "_resource_clients.actor_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over the Actors the user has created or used.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n", - "args": { - "my": "If True, will return only Actors which the user has created themselves.", - "limit": "How many Actors to list.", - "offset": "What Actor to include as first when retrieving the list.", - "desc": "Whether to sort the Actors in descending order based on their creation date.", - "sort_by": "Field to sort the results by.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 75 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the Actors the user has created or used.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n" - } - ] - }, - "flags": {}, - "id": 2276, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, will return only Actors which the user has created themselves." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2277, - "kind": 32768, - "kindString": "Parameter", - "name": "my", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many Actors to list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2278, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What Actor to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2279, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the Actors in descending order based on their creation date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2280, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Field to sort the results by." - } - ] - }, - "defaultValue": "'createdAt'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2281, - "kind": 32768, - "kindString": "Parameter", - "name": "sort_by", - "type": { - "name": "Literal['createdAt', 'stats.lastRunStartedAt'] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "createdAt" - }, - { - "type": "literal", - "value": "stats.lastRunStartedAt" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2282, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ActorShort", - "target": "246" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2283, - "module": "_resource_clients.actor_collection", - "name": "create", - "parsedDocstring": { - "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n", - "args": { - "name": "The name of the Actor.", - "title": "The title of the Actor (human-readable).", - "description": "The description for the Actor.", - "seo_title": "The title of the Actor optimized for search engines.", - "seo_description": "The description of the Actor optimized for search engines.", - "versions": "The list of Actor versions.", - "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.", - "is_public": "Whether the Actor is public.", - "is_deprecated": "Whether the Actor is deprecated.", - "categories": "The categories to which the Actor belongs to.", - "default_run_build": "Tag or number of the build that you want to run by default.", - "default_run_max_items": "Default limit of the number of results that will be returned by runs\nof this Actor, if the Actor is charged per result.", - "default_run_memory_mbytes": "Default amount of memory allocated for the runs of this Actor, in megabytes.", - "default_run_timeout": "Default timeout for the runs of this Actor.", - "example_run_input_body": "Input to be prefilled as default input to new users of this Actor.", - "example_run_input_content_type": "The content type of the example run input.", - "actor_standby_is_enabled": "Whether the Actor Standby is enabled.", - "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.", - "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.", - "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.", - "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.", - "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The created Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 109 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The created Actor." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n" - } - ] - }, - "flags": {}, - "id": 2284, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "create", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Actor." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 2285, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the Actor (human-readable)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2286, - "kind": 32768, - "kindString": "Parameter", - "name": "title", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description for the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2287, - "kind": 32768, - "kindString": "Parameter", - "name": "description", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the Actor optimized for search engines." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2288, - "kind": 32768, - "kindString": "Parameter", - "name": "seo_title", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description of the Actor optimized for search engines." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2289, - "kind": 32768, - "kindString": "Parameter", - "name": "seo_description", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of Actor versions." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2290, - "kind": 32768, - "kindString": "Parameter", - "name": "versions", - "type": { - "name": "list[dict[str, Any]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2291, - "kind": 32768, - "kindString": "Parameter", - "name": "restart_on_error", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Actor is public." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2292, - "kind": 32768, - "kindString": "Parameter", - "name": "is_public", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Actor is deprecated." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2293, - "kind": 32768, - "kindString": "Parameter", - "name": "is_deprecated", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The categories to which the Actor belongs to." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2294, - "kind": 32768, - "kindString": "Parameter", - "name": "categories", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tag or number of the build that you want to run by default." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2295, - "kind": 32768, - "kindString": "Parameter", - "name": "default_run_build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default limit of the number of results that will be returned by runs\nof this Actor, if the Actor is charged per result." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2296, - "kind": 32768, - "kindString": "Parameter", - "name": "default_run_max_items", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default amount of memory allocated for the runs of this Actor, in megabytes." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2297, - "kind": 32768, - "kindString": "Parameter", - "name": "default_run_memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for the runs of this Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2298, - "kind": 32768, - "kindString": "Parameter", - "name": "default_run_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Input to be prefilled as default input to new users of this Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2299, - "kind": 32768, - "kindString": "Parameter", - "name": "example_run_input_body", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type of the example run input." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2300, - "kind": 32768, - "kindString": "Parameter", - "name": "example_run_input_content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Actor Standby is enabled." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2301, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_is_enabled", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2302, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_desired_requests_per_actor_run", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2303, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_max_requests_per_actor_run", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the Actor run does not receive any requests for this time,\nit will be shut down." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2304, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_idle_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The build tag or number to run when the Actor is in Standby mode." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2305, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The memory in megabytes to use when the Actor is in Standby mode." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2306, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2307, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Actor", - "type": "reference", - "target": "192" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3997, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the Actor collection.\n\nProvides methods to manage the Actor collection, e.g. list or create Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2263, - 2283, - 2275, - 2267 - ], - "title": "Methods" - }, - { - "children": [ - 3997 - ], - "title": "Properties" - } - ], - "id": 2262, - "module": "_resource_clients.actor_collection", - "name": "ActorCollectionClient", - "parsedDocstring": { - "text": "Sub-client for the Actor collection.\n\nProvides methods to manage the Actor collection, e.g. list or create Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 29 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2309, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 215 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2313, - "module": "_resource_clients.actor_collection", - "name": "list", - "parsedDocstring": { - "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n", - "args": { - "my": "If True, will return only Actors which the user has created themselves.", - "limit": "How many Actors to list.", - "offset": "What Actor to include as first when retrieving the list.", - "desc": "Whether to sort the Actors in descending order based on their creation date.", - "sort_by": "Field to sort the results by.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available Actors matching the specified filters." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 226 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available Actors matching the specified filters." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n" - } - ] - }, - "flags": {}, - "id": 2314, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, will return only Actors which the user has created themselves." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2315, - "kind": 32768, - "kindString": "Parameter", - "name": "my", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many Actors to list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2316, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What Actor to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2317, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the Actors in descending order based on their creation date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2318, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Field to sort the results by." - } - ] - }, - "defaultValue": "'createdAt'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2319, - "kind": 32768, - "kindString": "Parameter", - "name": "sort_by", - "type": { - "name": "Literal['createdAt', 'stats.lastRunStartedAt'] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "createdAt" - }, - { - "type": "literal", - "value": "stats.lastRunStartedAt" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2320, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfActors", - "type": "reference", - "target": "753" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the Actors the user has created or used.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2321, - "module": "_resource_clients.actor_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over the Actors the user has created or used.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n", - "args": { - "my": "If True, will return only Actors which the user has created themselves.", - "limit": "How many Actors to list.", - "offset": "What Actor to include as first when retrieving the list.", - "desc": "Whether to sort the Actors in descending order based on their creation date.", - "sort_by": "Field to sort the results by.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 254 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the Actors the user has created or used.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n" - } - ] - }, - "flags": {}, - "id": 2322, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, will return only Actors which the user has created themselves." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2323, - "kind": 32768, - "kindString": "Parameter", - "name": "my", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many Actors to list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2324, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What Actor to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2325, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the Actors in descending order based on their creation date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2326, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Field to sort the results by." - } - ] - }, - "defaultValue": "'createdAt'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2327, - "kind": 32768, - "kindString": "Parameter", - "name": "sort_by", - "type": { - "name": "Literal['createdAt', 'stats.lastRunStartedAt'] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "createdAt" - }, - { - "type": "literal", - "value": "stats.lastRunStartedAt" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2328, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ActorShort", - "target": "246" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2329, - "module": "_resource_clients.actor_collection", - "name": "create", - "parsedDocstring": { - "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n", - "args": { - "name": "The name of the Actor.", - "title": "The title of the Actor (human-readable).", - "description": "The description for the Actor.", - "seo_title": "The title of the Actor optimized for search engines.", - "seo_description": "The description of the Actor optimized for search engines.", - "versions": "The list of Actor versions.", - "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.", - "is_public": "Whether the Actor is public.", - "is_deprecated": "Whether the Actor is deprecated.", - "categories": "The categories to which the Actor belongs to.", - "default_run_build": "Tag or number of the build that you want to run by default.", - "default_run_max_items": "Default limit of the number of results that will be returned by runs\nof this Actor, if the Actor is charged per result.", - "default_run_memory_mbytes": "Default amount of memory allocated for the runs of this Actor, in megabytes.", - "default_run_timeout": "Default timeout for the runs of this Actor.", - "example_run_input_body": "Input to be prefilled as default input to new users of this Actor.", - "example_run_input_content_type": "The content type of the example run input.", - "actor_standby_is_enabled": "Whether the Actor Standby is enabled.", - "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.", - "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.", - "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.", - "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.", - "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The created Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 288 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The created Actor." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n" - } - ] - }, - "flags": {}, - "id": 2330, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "create", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Actor." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 2331, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the Actor (human-readable)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2332, - "kind": 32768, - "kindString": "Parameter", - "name": "title", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description for the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2333, - "kind": 32768, - "kindString": "Parameter", - "name": "description", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the Actor optimized for search engines." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2334, - "kind": 32768, - "kindString": "Parameter", - "name": "seo_title", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description of the Actor optimized for search engines." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2335, - "kind": 32768, - "kindString": "Parameter", - "name": "seo_description", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of Actor versions." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2336, - "kind": 32768, - "kindString": "Parameter", - "name": "versions", - "type": { - "name": "list[dict[str, Any]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2337, - "kind": 32768, - "kindString": "Parameter", - "name": "restart_on_error", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Actor is public." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2338, - "kind": 32768, - "kindString": "Parameter", - "name": "is_public", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Actor is deprecated." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2339, - "kind": 32768, - "kindString": "Parameter", - "name": "is_deprecated", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The categories to which the Actor belongs to." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2340, - "kind": 32768, - "kindString": "Parameter", - "name": "categories", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tag or number of the build that you want to run by default." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2341, - "kind": 32768, - "kindString": "Parameter", - "name": "default_run_build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default limit of the number of results that will be returned by runs\nof this Actor, if the Actor is charged per result." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2342, - "kind": 32768, - "kindString": "Parameter", - "name": "default_run_max_items", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default amount of memory allocated for the runs of this Actor, in megabytes." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2343, - "kind": 32768, - "kindString": "Parameter", - "name": "default_run_memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for the runs of this Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2344, - "kind": 32768, - "kindString": "Parameter", - "name": "default_run_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Input to be prefilled as default input to new users of this Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2345, - "kind": 32768, - "kindString": "Parameter", - "name": "example_run_input_body", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type of the example run input." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2346, - "kind": 32768, - "kindString": "Parameter", - "name": "example_run_input_content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Actor Standby is enabled." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2347, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_is_enabled", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2348, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_desired_requests_per_actor_run", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2349, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_max_requests_per_actor_run", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the Actor run does not receive any requests for this time,\nit will be shut down." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2350, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_idle_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The build tag or number to run when the Actor is in Standby mode." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2351, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The memory in megabytes to use when the Actor is in Standby mode." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2352, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2353, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Actor", - "type": "reference", - "target": "192" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3970, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the Actor collection.\n\nProvides methods to manage the Actor collection, e.g. list or create Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2309, - 2329, - 2321, - 2313 - ], - "title": "Methods" - }, - { - "children": [ - 3970 - ], - "title": "Properties" - } - ], - "id": 2308, - "module": "_resource_clients.actor_collection", - "name": "ActorCollectionClientAsync", - "parsedDocstring": { - "text": "Sub-client for the Actor collection.\n\nProvides methods to manage the Actor collection, e.g. list or create Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 208 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2355, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_dispatch.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 21 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2360, - "module": "_resource_clients.webhook_dispatch", - "name": "get", - "parsedDocstring": { - "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved webhook dispatch, or None if it does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_dispatch.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 34 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved webhook dispatch, or None if it does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n" - } - ] - }, - "flags": {}, - "id": 2361, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2362, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "WebhookDispatch | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "WebhookDispatch", - "target": "1386" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3998, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific webhook dispatch.\n\nProvides methods to manage a specific webhook dispatch, e.g. get its details. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2355, - 2360 - ], - "title": "Methods" - }, - { - "children": [ - 3998 - ], - "title": "Properties" - } - ], - "id": 2354, - "module": "_resource_clients.webhook_dispatch", - "name": "WebhookDispatchClient", - "parsedDocstring": { - "text": "Sub-client for managing a specific webhook dispatch.\n\nProvides methods to manage a specific webhook dispatch, e.g. get its details. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_dispatch.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 14 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2364, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_dispatch.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 59 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2369, - "module": "_resource_clients.webhook_dispatch", - "name": "get", - "parsedDocstring": { - "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved webhook dispatch, or None if it does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_dispatch.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved webhook dispatch, or None if it does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n" - } - ] - }, - "flags": {}, - "id": 2370, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2371, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "WebhookDispatch | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "WebhookDispatch", - "target": "1386" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3971, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific webhook dispatch.\n\nProvides methods to manage a specific webhook dispatch, e.g. get its details. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2364, - 2369 - ], - "title": "Methods" - }, - { - "children": [ - 3971 - ], - "title": "Properties" - } - ], - "id": 2363, - "module": "_resource_clients.webhook_dispatch", - "name": "WebhookDispatchClientAsync", - "parsedDocstring": { - "text": "Sub-client for managing a specific webhook dispatch.\n\nProvides methods to manage a specific webhook dispatch, e.g. get its details. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_dispatch.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 52 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2373, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 30 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2377, - "module": "_resource_clients.key_value_store_collection", - "name": "list", - "parsedDocstring": { - "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n", - "args": { - "unnamed": "Whether to include unnamed key-value stores in the list.", - "limit": "How many key-value stores to retrieve.", - "offset": "What key-value store to include as first when retrieving the list.", - "desc": "Whether to sort the key-value stores in descending order based on their modification date.", - "ownership": "Filter by ownership. `'ownedByMe'` returns only user's own key-value stores,\n`'sharedWithMe'` returns only key-value stores shared with the user.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available key-value stores matching the specified filters." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 41 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available key-value stores matching the specified filters." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n" - } - ] - }, - "flags": {}, - "id": 2378, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include unnamed key-value stores in the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2379, - "kind": 32768, - "kindString": "Parameter", - "name": "unnamed", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many key-value stores to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2380, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What key-value store to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2381, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the key-value stores in descending order based on their modification date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2382, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by ownership. `'ownedByMe'` returns only user's own key-value stores,\n`'sharedWithMe'` returns only key-value stores shared with the user." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2383, - "kind": 32768, - "kindString": "Parameter", - "name": "ownership", - "type": { - "name": "StorageOwnership | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "StorageOwnership", - "target": "1801" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2384, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfKeyValueStores", - "type": "reference", - "target": "762" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available key-value stores.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2385, - "module": "_resource_clients.key_value_store_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over the available key-value stores.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n", - "args": { - "unnamed": "Whether to include unnamed key-value stores in the list.", - "limit": "How many key-value stores to retrieve.", - "offset": "What key-value store to include as first when retrieving the list.", - "desc": "Whether to sort the key-value stores in descending order based on their modification date.", - "ownership": "Filter by ownership. 'ownedByMe' returns only user's own key-value stores,\n'sharedWithMe' returns only key-value stores shared with the user.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 77 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available key-value stores.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n" - } - ] - }, - "flags": {}, - "id": 2386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include unnamed key-value stores in the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2387, - "kind": 32768, - "kindString": "Parameter", - "name": "unnamed", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many key-value stores to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2388, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What key-value store to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2389, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the key-value stores in descending order based on their modification date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2390, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by ownership. 'ownedByMe' returns only user's own key-value stores,\n'sharedWithMe' returns only key-value stores shared with the user." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2391, - "kind": 32768, - "kindString": "Parameter", - "name": "ownership", - "type": { - "name": "StorageOwnership | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "StorageOwnership", - "target": "1801" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2392, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "KeyValueStore", - "target": "595" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2393, - "module": "_resource_clients.key_value_store_collection", - "name": "get_or_create", - "parsedDocstring": { - "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n", - "args": { - "name": "The name of the key-value store to retrieve or create.", - "schema": "The schema of the key-value store.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved or newly-created key-value store." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 114 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved or newly-created key-value store." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n" - } - ] - }, - "flags": {}, - "id": 2394, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_or_create", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the key-value store to retrieve or create." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2395, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The schema of the key-value store." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2396, - "kind": 32768, - "kindString": "Parameter", - "name": "schema", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2397, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "KeyValueStore", - "type": "reference", - "target": "595" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3999, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the key-value store collection.\n\nProvides methods to manage the key-value store collection, e.g. list or create key-value stores. Obtain an instance\nvia an appropriate method on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2373, - 2393, - 2385, - 2377 - ], - "title": "Methods" - }, - { - "children": [ - 3999 - ], - "title": "Properties" - } - ], - "id": 2372, - "module": "_resource_clients.key_value_store_collection", - "name": "KeyValueStoreCollectionClient", - "parsedDocstring": { - "text": "Sub-client for the key-value store collection.\n\nProvides methods to manage the key-value store collection, e.g. list or create key-value stores. Obtain an instance\nvia an appropriate method on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 23 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2399, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 145 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2403, - "module": "_resource_clients.key_value_store_collection", - "name": "list", - "parsedDocstring": { - "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n", - "args": { - "unnamed": "Whether to include unnamed key-value stores in the list.", - "limit": "How many key-value stores to retrieve.", - "offset": "What key-value store to include as first when retrieving the list.", - "desc": "Whether to sort the key-value stores in descending order based on their modification date.", - "ownership": "Filter by ownership. `'ownedByMe'` returns only user's own key-value stores,\n`'sharedWithMe'` returns only key-value stores shared with the user.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available key-value stores matching the specified filters." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 156 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available key-value stores matching the specified filters." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n" - } - ] - }, - "flags": {}, - "id": 2404, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include unnamed key-value stores in the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2405, - "kind": 32768, - "kindString": "Parameter", - "name": "unnamed", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many key-value stores to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2406, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What key-value store to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2407, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the key-value stores in descending order based on their modification date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2408, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by ownership. `'ownedByMe'` returns only user's own key-value stores,\n`'sharedWithMe'` returns only key-value stores shared with the user." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2409, - "kind": 32768, - "kindString": "Parameter", - "name": "ownership", - "type": { - "name": "StorageOwnership | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "StorageOwnership", - "target": "1801" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2410, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfKeyValueStores", - "type": "reference", - "target": "762" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available key-value stores.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2411, - "module": "_resource_clients.key_value_store_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over the available key-value stores.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n", - "args": { - "unnamed": "Whether to include unnamed key-value stores in the list.", - "limit": "How many key-value stores to retrieve.", - "offset": "What key-value store to include as first when retrieving the list.", - "desc": "Whether to sort the key-value stores in descending order based on their modification date.", - "ownership": "Filter by ownership. 'ownedByMe' returns only user's own key-value stores,\n'sharedWithMe' returns only key-value stores shared with the user.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 192 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available key-value stores.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n" - } - ] - }, - "flags": {}, - "id": 2412, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include unnamed key-value stores in the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2413, - "kind": 32768, - "kindString": "Parameter", - "name": "unnamed", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many key-value stores to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2414, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What key-value store to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2415, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the key-value stores in descending order based on their modification date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2416, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by ownership. 'ownedByMe' returns only user's own key-value stores,\n'sharedWithMe' returns only key-value stores shared with the user." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2417, - "kind": 32768, - "kindString": "Parameter", - "name": "ownership", - "type": { - "name": "StorageOwnership | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "StorageOwnership", - "target": "1801" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2418, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "KeyValueStore", - "target": "595" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2419, - "module": "_resource_clients.key_value_store_collection", - "name": "get_or_create", - "parsedDocstring": { - "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n", - "args": { - "name": "The name of the key-value store to retrieve or create.", - "schema": "The schema of the key-value store.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved or newly-created key-value store." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 229 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved or newly-created key-value store." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n" - } - ] - }, - "flags": {}, - "id": 2420, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_or_create", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the key-value store to retrieve or create." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2421, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The schema of the key-value store." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2422, - "kind": 32768, - "kindString": "Parameter", - "name": "schema", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2423, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "KeyValueStore", - "type": "reference", - "target": "595" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3972, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the key-value store collection.\n\nProvides methods to manage the key-value store collection, e.g. list or create key-value stores. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2399, - 2419, - 2411, - 2403 - ], - "title": "Methods" - }, - { - "children": [ - 3972 - ], - "title": "Properties" - } - ], - "id": 2398, - "module": "_resource_clients.key_value_store_collection", - "name": "KeyValueStoreCollectionClientAsync", - "parsedDocstring": { - "text": "Sub-client for the key-value store collection.\n\nProvides methods to manage the key-value store collection, e.g. list or create key-value stores. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 138 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2425, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 39 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2430, - "module": "_resource_clients.actor_version", - "name": "get", - "parsedDocstring": { - "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved Actor version data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 52 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved Actor version data." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n" - } - ] - }, - "flags": {}, - "id": 2431, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2432, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Version | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Version", - "target": "1336" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2433, - "module": "_resource_clients.actor_version", - "name": "update", - "parsedDocstring": { - "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n", - "args": { - "build_tag": "Tag that is automatically set to the latest successful build of the current version.", - "env_vars": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure.", - "apply_env_vars_to_build": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process.", - "source_type": "What source type is the Actor version using.", - "source_files": "Source code comprised of multiple files, each an item of the array. Required when\n`source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure.", - "git_repo_url": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`.", - "tarball_url": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`.", - "github_gist_url": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated Actor version." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 68 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated Actor version." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n" - } - ] - }, - "flags": {}, - "id": 2434, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tag that is automatically set to the latest successful build of the current version." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2435, - "kind": 32768, - "kindString": "Parameter", - "name": "build_tag", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2436, - "kind": 32768, - "kindString": "Parameter", - "name": "env_vars", - "type": { - "name": "list[dict[str, Any]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2437, - "kind": 32768, - "kindString": "Parameter", - "name": "apply_env_vars_to_build", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What source type is the Actor version using." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2438, - "kind": 32768, - "kindString": "Parameter", - "name": "source_type", - "type": { - "name": "VersionSourceType | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "VersionSourceType", - "target": "1802" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Source code comprised of multiple files, each an item of the array. Required when\n`source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2439, - "kind": 32768, - "kindString": "Parameter", - "name": "source_files", - "type": { - "name": "list[dict[str, Any]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2440, - "kind": 32768, - "kindString": "Parameter", - "name": "git_repo_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2441, - "kind": 32768, - "kindString": "Parameter", - "name": "tarball_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2442, - "kind": 32768, - "kindString": "Parameter", - "name": "github_gist_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2443, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Version", - "type": "reference", - "target": "1336" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2444, - "module": "_resource_clients.actor_version", - "name": "delete", - "parsedDocstring": { - "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 118 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version\n" - } - ] - }, - "flags": {}, - "id": 2445, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2446, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the environment variables of this Actor version." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2447, - "module": "_resource_clients.actor_version", - "name": "env_vars", - "parsedDocstring": { - "text": "Retrieve a client for the environment variables of this Actor version." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 128 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the environment variables of this Actor version." - } - ] - }, - "flags": {}, - "id": 2448, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "env_vars", - "parameters": [], - "type": { - "name": "ActorEnvVarCollectionClient", - "type": "reference", - "target": "2194" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the client for the specified environment variable of this Actor version.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2449, - "module": "_resource_clients.actor_version", - "name": "env_var", - "parsedDocstring": { - "text": "Retrieve the client for the specified environment variable of this Actor version.\n", - "args": { - "env_var_name": "The name of the environment variable for which to retrieve the resource client.\n" - }, - "returns": "The resource client for the specified Actor environment variable." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 132 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The resource client for the specified Actor environment variable." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the client for the specified environment variable of this Actor version.\n" - } - ] - }, - "flags": {}, - "id": 2450, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "env_var", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the environment variable for which to retrieve the resource client.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2451, - "kind": 32768, - "kindString": "Parameter", - "name": "env_var_name", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "ActorEnvVarClient", - "type": "reference", - "target": "3758" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 4000, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific Actor version.\n\nProvides methods to manage a specific Actor version, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ActorClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2425, - 2444, - 2449, - 2447, - 2430, - 2433 - ], - "title": "Methods" - }, - { - "children": [ - 4000 - ], - "title": "Properties" - } - ], - "id": 2424, - "module": "_resource_clients.actor_version", - "name": "ActorVersionClient", - "parsedDocstring": { - "text": "Sub-client for managing a specific Actor version.\n\nProvides methods to manage a specific Actor version, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ActorClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 32 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2453, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 155 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2458, - "module": "_resource_clients.actor_version", - "name": "get", - "parsedDocstring": { - "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved Actor version data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 168 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved Actor version data." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n" - } - ] - }, - "flags": {}, - "id": 2459, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2460, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Version | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Version", - "target": "1336" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2461, - "module": "_resource_clients.actor_version", - "name": "update", - "parsedDocstring": { - "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n", - "args": { - "build_tag": "Tag that is automatically set to the latest successful build of the current version.", - "env_vars": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure.", - "apply_env_vars_to_build": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process.", - "source_type": "What source type is the Actor version using.", - "source_files": "Source code comprised of multiple files, each an item of the array. Required when\n`source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure.", - "git_repo_url": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`.", - "tarball_url": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`.", - "github_gist_url": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated Actor version." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 184 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated Actor version." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n" - } - ] - }, - "flags": {}, - "id": 2462, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tag that is automatically set to the latest successful build of the current version." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2463, - "kind": 32768, - "kindString": "Parameter", - "name": "build_tag", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2464, - "kind": 32768, - "kindString": "Parameter", - "name": "env_vars", - "type": { - "name": "list[dict[str, Any]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2465, - "kind": 32768, - "kindString": "Parameter", - "name": "apply_env_vars_to_build", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What source type is the Actor version using." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2466, - "kind": 32768, - "kindString": "Parameter", - "name": "source_type", - "type": { - "name": "VersionSourceType | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "VersionSourceType", - "target": "1802" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Source code comprised of multiple files, each an item of the array. Required when\n`source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2467, - "kind": 32768, - "kindString": "Parameter", - "name": "source_files", - "type": { - "name": "list[dict[str, Any]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2468, - "kind": 32768, - "kindString": "Parameter", - "name": "git_repo_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2469, - "kind": 32768, - "kindString": "Parameter", - "name": "tarball_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2470, - "kind": 32768, - "kindString": "Parameter", - "name": "github_gist_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2471, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Version", - "type": "reference", - "target": "1336" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2472, - "module": "_resource_clients.actor_version", - "name": "delete", - "parsedDocstring": { - "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 234 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version\n" - } - ] - }, - "flags": {}, - "id": 2473, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2474, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the environment variables of this Actor version." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2475, - "module": "_resource_clients.actor_version", - "name": "env_vars", - "parsedDocstring": { - "text": "Retrieve a client for the environment variables of this Actor version." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 244 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the environment variables of this Actor version." - } - ] - }, - "flags": {}, - "id": 2476, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "env_vars", - "parameters": [], - "type": { - "name": "ActorEnvVarCollectionClientAsync", - "type": "reference", - "target": "2211" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the client for the specified environment variable of this Actor version.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2477, - "module": "_resource_clients.actor_version", - "name": "env_var", - "parsedDocstring": { - "text": "Retrieve the client for the specified environment variable of this Actor version.\n", - "args": { - "env_var_name": "The name of the environment variable for which to retrieve the resource client.\n" - }, - "returns": "The resource client for the specified Actor environment variable." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 248 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The resource client for the specified Actor environment variable." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the client for the specified environment variable of this Actor version.\n" - } - ] - }, - "flags": {}, - "id": 2478, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "env_var", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the environment variable for which to retrieve the resource client.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2479, - "kind": 32768, - "kindString": "Parameter", - "name": "env_var_name", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "ActorEnvVarClientAsync", - "type": "reference", - "target": "3776" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3973, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific Actor version.\n\nProvides methods to manage a specific Actor version, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ActorClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2453, - 2472, - 2477, - 2475, - 2458, - 2461 - ], - "title": "Methods" - }, - { - "children": [ - 3973 - ], - "title": "Properties" - } - ], - "id": 2452, - "module": "_resource_clients.actor_version", - "name": "ActorVersionClientAsync", - "parsedDocstring": { - "text": "Sub-client for managing a specific Actor version.\n\nProvides methods to manage a specific Actor version, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ActorClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 148 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2481, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 31 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2485, - "module": "_resource_clients.request_queue_collection", - "name": "list", - "parsedDocstring": { - "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n", - "args": { - "unnamed": "Whether to include unnamed request queues in the list.", - "limit": "How many request queues to retrieve.", - "offset": "What request queue to include as first when retrieving the list.", - "desc": "Whether to sort the request queues in descending order based on their modification date.", - "ownership": "Filter by ownership. `'ownedByMe'` returns only user's own request queues,\n`'sharedWithMe'` returns only request queues shared with the user.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available request queues matching the specified filters." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 42 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available request queues matching the specified filters." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n" - } - ] - }, - "flags": {}, - "id": 2486, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include unnamed request queues in the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2487, - "kind": 32768, - "kindString": "Parameter", - "name": "unnamed", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many request queues to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2488, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What request queue to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2489, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the request queues in descending order based on their modification date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2490, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by ownership. `'ownedByMe'` returns only user's own request queues,\n`'sharedWithMe'` returns only request queues shared with the user." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2491, - "kind": 32768, - "kindString": "Parameter", - "name": "ownership", - "type": { - "name": "StorageOwnership | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "StorageOwnership", - "target": "1801" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2492, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfRequestQueues", - "type": "reference", - "target": "765" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available request queues.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2493, - "module": "_resource_clients.request_queue_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over the available request queues.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n", - "args": { - "unnamed": "Whether to include unnamed request queues in the list.", - "limit": "How many request queues to retrieve.", - "offset": "What request queue to include as first when retrieving the list.", - "desc": "Whether to sort the request queues in descending order based on their modification date.", - "ownership": "Filter by ownership. 'ownedByMe' returns only user's own request queues,\n'sharedWithMe' returns only request queues shared with the user.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 78 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available request queues.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n" - } - ] - }, - "flags": {}, - "id": 2494, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include unnamed request queues in the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2495, - "kind": 32768, - "kindString": "Parameter", - "name": "unnamed", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many request queues to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2496, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What request queue to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2497, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the request queues in descending order based on their modification date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2498, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by ownership. 'ownedByMe' returns only user's own request queues,\n'sharedWithMe' returns only request queues shared with the user." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2499, - "kind": 32768, - "kindString": "Parameter", - "name": "ownership", - "type": { - "name": "StorageOwnership | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "StorageOwnership", - "target": "1801" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2500, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "RequestQueueShort", - "target": "922" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2501, - "module": "_resource_clients.request_queue_collection", - "name": "get_or_create", - "parsedDocstring": { - "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n", - "args": { - "name": "The name of the request queue to retrieve or create.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved or newly-created request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 115 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved or newly-created request queue." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n" - } - ] - }, - "flags": {}, - "id": 2502, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_or_create", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the request queue to retrieve or create." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2503, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2504, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "RequestQueue", - "type": "reference", - "target": "898" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 4001, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the request queue collection.\n\nProvides methods to manage the request queue collection, e.g. list or create request queues. Obtain an instance\nvia an appropriate method on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2481, - 2501, - 2493, - 2485 - ], - "title": "Methods" - }, - { - "children": [ - 4001 - ], - "title": "Properties" - } - ], - "id": 2480, - "module": "_resource_clients.request_queue_collection", - "name": "RequestQueueCollectionClient", - "parsedDocstring": { - "text": "Sub-client for the request queue collection.\n\nProvides methods to manage the request queue collection, e.g. list or create request queues. Obtain an instance\nvia an appropriate method on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 24 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2506, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 144 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2510, - "module": "_resource_clients.request_queue_collection", - "name": "list", - "parsedDocstring": { - "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n", - "args": { - "unnamed": "Whether to include unnamed request queues in the list.", - "limit": "How many request queues to retrieve.", - "offset": "What request queue to include as first when retrieving the list.", - "desc": "Whether to sort the request queues in descending order based on their modification date.", - "ownership": "Filter by ownership. `'ownedByMe'` returns only user's own request queues,\n`'sharedWithMe'` returns only request queues shared with the user.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available request queues matching the specified filters." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 155 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available request queues matching the specified filters." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n" - } - ] - }, - "flags": {}, - "id": 2511, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include unnamed request queues in the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2512, - "kind": 32768, - "kindString": "Parameter", - "name": "unnamed", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many request queues to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2513, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What request queue to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2514, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the request queues in descending order based on their modification date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2515, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by ownership. `'ownedByMe'` returns only user's own request queues,\n`'sharedWithMe'` returns only request queues shared with the user." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2516, - "kind": 32768, - "kindString": "Parameter", - "name": "ownership", - "type": { - "name": "StorageOwnership | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "StorageOwnership", - "target": "1801" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2517, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfRequestQueues", - "type": "reference", - "target": "765" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available request queues.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2518, - "module": "_resource_clients.request_queue_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over the available request queues.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n", - "args": { - "unnamed": "Whether to include unnamed request queues in the list.", - "limit": "How many request queues to retrieve.", - "offset": "What request queue to include as first when retrieving the list.", - "desc": "Whether to sort the request queues in descending order based on their modification date.", - "ownership": "Filter by ownership. 'ownedByMe' returns only user's own request queues,\n'sharedWithMe' returns only request queues shared with the user.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 191 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available request queues.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n" - } - ] - }, - "flags": {}, - "id": 2519, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include unnamed request queues in the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2520, - "kind": 32768, - "kindString": "Parameter", - "name": "unnamed", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many request queues to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2521, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What request queue to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2522, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the request queues in descending order based on their modification date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2523, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by ownership. 'ownedByMe' returns only user's own request queues,\n'sharedWithMe' returns only request queues shared with the user." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2524, - "kind": 32768, - "kindString": "Parameter", - "name": "ownership", - "type": { - "name": "StorageOwnership | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "StorageOwnership", - "target": "1801" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2525, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "RequestQueueShort", - "target": "922" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2526, - "module": "_resource_clients.request_queue_collection", - "name": "get_or_create", - "parsedDocstring": { - "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n", - "args": { - "name": "The name of the request queue to retrieve or create.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved or newly-created request queue." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 228 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved or newly-created request queue." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n" - } - ] - }, - "flags": {}, - "id": 2527, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_or_create", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the request queue to retrieve or create." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2528, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2529, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "RequestQueue", - "type": "reference", - "target": "898" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3974, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the request queue collection.\n\nProvides methods to manage the request queue collection, e.g. list or create request queues. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2506, - 2526, - 2518, - 2510 - ], - "title": "Methods" - }, - { - "children": [ - 3974 - ], - "title": "Properties" - } - ], - "id": 2505, - "module": "_resource_clients.request_queue_collection", - "name": "RequestQueueCollectionClientAsync", - "parsedDocstring": { - "text": "Sub-client for the request queue collection.\n\nProvides methods to manage the request queue collection, e.g. list or create request queues. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 137 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2531, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 37 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2535, - "module": "_resource_clients.task_collection", - "name": "list", - "parsedDocstring": { - "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n", - "args": { - "limit": "How many tasks to list.", - "offset": "What task to include as first when retrieving the list.", - "desc": "Whether to sort the tasks in descending order based on their creation date.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available tasks matching the specified filters." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 48 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available tasks matching the specified filters." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n" - } - ] - }, - "flags": {}, - "id": 2536, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many tasks to list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2537, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What task to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2538, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the tasks in descending order based on their creation date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2539, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2540, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfTasks", - "type": "reference", - "target": "777" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available tasks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2541, - "module": "_resource_clients.task_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over the available tasks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n", - "args": { - "limit": "How many tasks to list.", - "offset": "What task to include as first when retrieving the list.", - "desc": "Whether to sort the tasks in descending order based on their creation date.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available tasks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n" - } - ] - }, - "flags": {}, - "id": 2542, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many tasks to list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2543, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What task to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2544, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the tasks in descending order based on their creation date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2545, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2546, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "TaskShort", - "target": "1226" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2547, - "module": "_resource_clients.task_collection", - "name": "create", - "parsedDocstring": { - "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n", - "args": { - "actor_id": "Id of the Actor that should be run.", - "name": "Name of the task.", - "build": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest).", - "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.", - "max_items": "Maximum number of results that will be returned by runs of this task. If the Actor of this task\nis charged per result, you will not be charged for more results than the given limit.", - "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.", - "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.", - "task_input": "Task input object.", - "title": "A human-friendly equivalent of the name.", - "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.", - "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.", - "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.", - "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.", - "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The created task." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 102 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The created task." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n" - } - ] - }, - "flags": {}, - "id": 2548, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "create", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Id of the Actor that should be run." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 2549, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the task." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 2550, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2551, - "kind": 32768, - "kindString": "Parameter", - "name": "build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2552, - "kind": 32768, - "kindString": "Parameter", - "name": "run_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2553, - "kind": 32768, - "kindString": "Parameter", - "name": "memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results that will be returned by runs of this task. If the Actor of this task\nis charged per result, you will not be charged for more results than the given limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2554, - "kind": 32768, - "kindString": "Parameter", - "name": "max_items", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2555, - "kind": 32768, - "kindString": "Parameter", - "name": "restart_on_error", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Task input object." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2556, - "kind": 32768, - "kindString": "Parameter", - "name": "task_input", - "type": { - "name": "TaskInputDict | TaskInput | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict[str, Any]" - }, - { - "type": "reference", - "name": "TaskInput", - "target": "1213" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A human-friendly equivalent of the name." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2557, - "kind": 32768, - "kindString": "Parameter", - "name": "title", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2558, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_desired_requests_per_actor_run", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2559, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_max_requests_per_actor_run", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the Actor run does not receive any requests for this time,\nit will be shut down." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2560, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_idle_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The build tag or number to run when the Actor is in Standby mode." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2561, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The memory in megabytes to use when the Actor is in Standby mode." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2562, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2563, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Task", - "type": "reference", - "target": "1197" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 4002, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the task collection.\n\nProvides methods to manage the task collection, e.g. list or create tasks. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2531, - 2547, - 2541, - 2535 - ], - "title": "Methods" - }, - { - "children": [ - 4002 - ], - "title": "Properties" - } - ], - "id": 2530, - "module": "_resource_clients.task_collection", - "name": "TaskCollectionClient", - "parsedDocstring": { - "text": "Sub-client for the task collection.\n\nProvides methods to manage the task collection, e.g. list or create tasks. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 30 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2565, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 188 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2569, - "module": "_resource_clients.task_collection", - "name": "list", - "parsedDocstring": { - "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n", - "args": { - "limit": "How many tasks to list.", - "offset": "What task to include as first when retrieving the list.", - "desc": "Whether to sort the tasks in descending order based on their creation date.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available tasks matching the specified filters." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 199 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available tasks matching the specified filters." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n" - } - ] - }, - "flags": {}, - "id": 2570, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many tasks to list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2571, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What task to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2572, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the tasks in descending order based on their creation date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2573, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2574, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfTasks", - "type": "reference", - "target": "777" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available tasks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2575, - "module": "_resource_clients.task_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over the available tasks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n", - "args": { - "limit": "How many tasks to list.", - "offset": "What task to include as first when retrieving the list.", - "desc": "Whether to sort the tasks in descending order based on their creation date.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 223 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available tasks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n" - } - ] - }, - "flags": {}, - "id": 2576, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many tasks to list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2577, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What task to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2578, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the tasks in descending order based on their creation date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2579, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2580, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "TaskShort", - "target": "1226" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2581, - "module": "_resource_clients.task_collection", - "name": "create", - "parsedDocstring": { - "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n", - "args": { - "actor_id": "Id of the Actor that should be run.", - "name": "Name of the task.", - "build": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest).", - "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.", - "max_items": "Maximum number of results that will be returned by runs of this task. If the Actor of this task\nis charged per result, you will not be charged for more results than the given limit.", - "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.", - "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.", - "task_input": "Task input object.", - "title": "A human-friendly equivalent of the name.", - "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.", - "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.", - "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.", - "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.", - "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The created task." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 253 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The created task." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n" - } - ] - }, - "flags": {}, - "id": 2582, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "create", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Id of the Actor that should be run." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 2583, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the task." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 2584, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2585, - "kind": 32768, - "kindString": "Parameter", - "name": "build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2586, - "kind": 32768, - "kindString": "Parameter", - "name": "run_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2587, - "kind": 32768, - "kindString": "Parameter", - "name": "memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results that will be returned by runs of this task. If the Actor of this task\nis charged per result, you will not be charged for more results than the given limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2588, - "kind": 32768, - "kindString": "Parameter", - "name": "max_items", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2589, - "kind": 32768, - "kindString": "Parameter", - "name": "restart_on_error", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Task input object." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2590, - "kind": 32768, - "kindString": "Parameter", - "name": "task_input", - "type": { - "name": "TaskInputDict | TaskInput | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict[str, Any]" - }, - { - "type": "reference", - "name": "TaskInput", - "target": "1213" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A human-friendly equivalent of the name." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2591, - "kind": 32768, - "kindString": "Parameter", - "name": "title", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2592, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_desired_requests_per_actor_run", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2593, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_max_requests_per_actor_run", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the Actor run does not receive any requests for this time,\nit will be shut down." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2594, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_idle_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The build tag or number to run when the Actor is in Standby mode." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2595, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The memory in megabytes to use when the Actor is in Standby mode." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2596, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2597, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Task", - "type": "reference", - "target": "1197" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3975, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the task collection.\n\nProvides methods to manage the task collection, e.g. list or create tasks. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2565, - 2581, - 2575, - 2569 - ], - "title": "Methods" - }, - { - "children": [ - 3975 - ], - "title": "Properties" - } - ], - "id": 2564, - "module": "_resource_clients.task_collection", - "name": "TaskCollectionClientAsync", - "parsedDocstring": { - "text": "Sub-client for the task collection.\n\nProvides methods to manage the task collection, e.g. list or create tasks. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 181 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2599, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/store_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 25 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2603, - "module": "_resource_clients.store_collection", - "name": "list", - "parsedDocstring": { - "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n", - "args": { - "limit": "How many Actors to list.", - "offset": "What Actor to include as first when retrieving the list.", - "search": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme.", - "sort_by": "Specifies the field by which to sort the results.", - "category": "Filter by this category.", - "username": "Filter by this username.", - "pricing_model": "Filter by this pricing model.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available Actors matching the specified filters." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/store_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 36 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available Actors matching the specified filters." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n" - } - ] - }, - "flags": {}, - "id": 2604, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many Actors to list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2605, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What Actor to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2606, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2607, - "kind": 32768, - "kindString": "Parameter", - "name": "search", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the field by which to sort the results." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2608, - "kind": 32768, - "kindString": "Parameter", - "name": "sort_by", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by this category." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2609, - "kind": 32768, - "kindString": "Parameter", - "name": "category", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by this username." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2610, - "kind": 32768, - "kindString": "Parameter", - "name": "username", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by this pricing model." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2611, - "kind": 32768, - "kindString": "Parameter", - "name": "pricing_model", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2612, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfStoreActors", - "type": "reference", - "target": "774" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over Actors in Apify store.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2613, - "module": "_resource_clients.store_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over Actors in Apify store.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n", - "args": { - "limit": "How many Actors to list.", - "offset": "What Actor to include as first when retrieving the list.", - "search": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme.", - "sort_by": "Specifies the field by which to sort the results.", - "category": "Filter by this category.", - "username": "Filter by this username.", - "pricing_model": "Filter by this pricing model.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/store_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 78 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over Actors in Apify store.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n" - } - ] - }, - "flags": {}, - "id": 2614, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many Actors to list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2615, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What Actor to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2616, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2617, - "kind": 32768, - "kindString": "Parameter", - "name": "search", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the field by which to sort the results." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2618, - "kind": 32768, - "kindString": "Parameter", - "name": "sort_by", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by this category." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2619, - "kind": 32768, - "kindString": "Parameter", - "name": "category", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by this username." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2620, - "kind": 32768, - "kindString": "Parameter", - "name": "username", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by this pricing model." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2621, - "kind": 32768, - "kindString": "Parameter", - "name": "pricing_model", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2622, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "StoreListActor", - "target": "1175" - } - ] - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 4003, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the Apify store collection.\n\nProvides methods to browse the Apify store, e.g. list available Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2599, - 2613, - 2603 - ], - "title": "Methods" - }, - { - "children": [ - 4003 - ], - "title": "Properties" - } - ], - "id": 2598, - "module": "_resource_clients.store_collection", - "name": "StoreCollectionClient", - "parsedDocstring": { - "text": "Sub-client for the Apify store collection.\n\nProvides methods to browse the Apify store, e.g. list available Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/store_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 18 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2624, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/store_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 135 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2628, - "module": "_resource_clients.store_collection", - "name": "list", - "parsedDocstring": { - "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n", - "args": { - "limit": "How many Actors to list.", - "offset": "What Actor to include as first when retrieving the list.", - "search": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme.", - "sort_by": "Specifies the field by which to sort the results.", - "category": "Filter by this category.", - "username": "Filter by this username.", - "pricing_model": "Filter by this pricing model.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available Actors matching the specified filters." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/store_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 146 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available Actors matching the specified filters." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n" - } - ] - }, - "flags": {}, - "id": 2629, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many Actors to list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2630, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What Actor to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2631, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2632, - "kind": 32768, - "kindString": "Parameter", - "name": "search", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the field by which to sort the results." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2633, - "kind": 32768, - "kindString": "Parameter", - "name": "sort_by", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by this category." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2634, - "kind": 32768, - "kindString": "Parameter", - "name": "category", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by this username." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2635, - "kind": 32768, - "kindString": "Parameter", - "name": "username", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by this pricing model." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2636, - "kind": 32768, - "kindString": "Parameter", - "name": "pricing_model", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2637, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfStoreActors", - "type": "reference", - "target": "774" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over Actors in Apify store.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2638, - "module": "_resource_clients.store_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over Actors in Apify store.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n", - "args": { - "limit": "How many Actors to list.", - "offset": "What Actor to include as first when retrieving the list.", - "search": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme.", - "sort_by": "Specifies the field by which to sort the results.", - "category": "Filter by this category.", - "username": "Filter by this username.", - "pricing_model": "Filter by this pricing model.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/store_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 188 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over Actors in Apify store.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n" - } - ] - }, - "flags": {}, - "id": 2639, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many Actors to list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2640, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What Actor to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2641, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2642, - "kind": 32768, - "kindString": "Parameter", - "name": "search", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the field by which to sort the results." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2643, - "kind": 32768, - "kindString": "Parameter", - "name": "sort_by", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by this category." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2644, - "kind": 32768, - "kindString": "Parameter", - "name": "category", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by this username." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2645, - "kind": 32768, - "kindString": "Parameter", - "name": "username", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by this pricing model." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2646, - "kind": 32768, - "kindString": "Parameter", - "name": "pricing_model", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2647, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "StoreListActor", - "target": "1175" - } - ] - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3976, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the Apify store collection.\n\nProvides methods to browse the Apify store, e.g. list available Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2624, - 2638, - 2628 - ], - "title": "Methods" - }, - { - "children": [ - 3976 - ], - "title": "Properties" - } - ], - "id": 2623, - "module": "_resource_clients.store_collection", - "name": "StoreCollectionClientAsync", - "parsedDocstring": { - "text": "Sub-client for the Apify store collection.\n\nProvides methods to browse the Apify store, e.g. list available Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/store_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 128 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2649, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 43 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2654, - "module": "_resource_clients.task", - "name": "get", - "parsedDocstring": { - "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved task." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 52 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved task." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n" - } - ] - }, - "flags": {}, - "id": 2655, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2656, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Task | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Task", - "target": "1197" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2657, - "module": "_resource_clients.task", - "name": "update", - "parsedDocstring": { - "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n", - "args": { - "name": "Name of the task.", - "build": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest).", - "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit.", - "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.", - "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.", - "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.", - "task_input": "Task input dictionary.", - "title": "A human-friendly equivalent of the name.", - "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.", - "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.", - "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.", - "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.", - "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated task." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 68 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated task." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n" - } - ] - }, - "flags": {}, - "id": 2658, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the task." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2659, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Task input dictionary." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2660, - "kind": 32768, - "kindString": "Parameter", - "name": "task_input", - "type": { - "name": "TaskInputDict | TaskInput | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict[str, Any]" - }, - { - "type": "reference", - "name": "TaskInput", - "target": "1213" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2661, - "kind": 32768, - "kindString": "Parameter", - "name": "build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2662, - "kind": 32768, - "kindString": "Parameter", - "name": "max_items", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2663, - "kind": 32768, - "kindString": "Parameter", - "name": "memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2664, - "kind": 32768, - "kindString": "Parameter", - "name": "run_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2665, - "kind": 32768, - "kindString": "Parameter", - "name": "restart_on_error", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A human-friendly equivalent of the name." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2666, - "kind": 32768, - "kindString": "Parameter", - "name": "title", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2667, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_desired_requests_per_actor_run", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2668, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_max_requests_per_actor_run", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the Actor run does not receive any requests for this time,\nit will be shut down." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2669, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_idle_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The build tag or number to run when the Actor is in Standby mode." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2670, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The memory in megabytes to use when the Actor is in Standby mode." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2671, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2672, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Task", - "type": "reference", - "target": "1197" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2673, - "module": "_resource_clients.task", - "name": "delete", - "parsedDocstring": { - "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 142 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task\n" - } - ] - }, - "flags": {}, - "id": 2674, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2675, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2676, - "module": "_resource_clients.task", - "name": "start", - "parsedDocstring": { - "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n", - "args": { - "task_input": "Task input dictionary.", - "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest).", - "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit.", - "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.", - "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.", - "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.", - "wait_for_finish": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60.", - "webhooks": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The run object." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 152 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The run object." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n" - } - ] - }, - "flags": {}, - "id": 2677, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "start", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Task input dictionary." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2678, - "kind": 32768, - "kindString": "Parameter", - "name": "task_input", - "type": { - "name": "TaskInputDict | TaskInput | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict[str, Any]" - }, - { - "type": "reference", - "name": "TaskInput", - "target": "1213" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2679, - "kind": 32768, - "kindString": "Parameter", - "name": "build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2680, - "kind": 32768, - "kindString": "Parameter", - "name": "max_items", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2681, - "kind": 32768, - "kindString": "Parameter", - "name": "memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2682, - "kind": 32768, - "kindString": "Parameter", - "name": "run_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2683, - "kind": 32768, - "kindString": "Parameter", - "name": "restart_on_error", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2684, - "kind": 32768, - "kindString": "Parameter", - "name": "wait_for_finish", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2685, - "kind": 32768, - "kindString": "Parameter", - "name": "webhooks", - "type": { - "name": "WebhooksList | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "WebhooksList", - "target": "14" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2686, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run", - "type": "reference", - "target": "958" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2687, - "module": "_resource_clients.task", - "name": "call", - "parsedDocstring": { - "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n", - "args": { - "task_input": "Task input dictionary.", - "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest).", - "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit.", - "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.", - "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.", - "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.", - "webhooks": "Specifies optional webhooks associated with the Actor run, which can be used to receive\na notification e.g. when the Actor finished or failed. Note: if you already have a webhook set up for\nthe Actor or task, you do not have to add it again here.", - "wait_duration": "The maximum time the server waits for the task run to finish. If not provided,\nwaits indefinitely.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The run object." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 220 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The run object." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n" - } - ] - }, - "flags": {}, - "id": 2688, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "call", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Task input dictionary." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2689, - "kind": 32768, - "kindString": "Parameter", - "name": "task_input", - "type": { - "name": "TaskInputDict | TaskInput | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict[str, Any]" - }, - { - "type": "reference", - "name": "TaskInput", - "target": "1213" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2690, - "kind": 32768, - "kindString": "Parameter", - "name": "build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2691, - "kind": 32768, - "kindString": "Parameter", - "name": "max_items", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2692, - "kind": 32768, - "kindString": "Parameter", - "name": "memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2693, - "kind": 32768, - "kindString": "Parameter", - "name": "run_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2694, - "kind": 32768, - "kindString": "Parameter", - "name": "restart_on_error", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies optional webhooks associated with the Actor run, which can be used to receive\na notification e.g. when the Actor finished or failed. Note: if you already have a webhook set up for\nthe Actor or task, you do not have to add it again here." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2695, - "kind": 32768, - "kindString": "Parameter", - "name": "webhooks", - "type": { - "name": "WebhooksList | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "WebhooksList", - "target": "14" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum time the server waits for the task run to finish. If not provided,\nwaits indefinitely." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2696, - "kind": 32768, - "kindString": "Parameter", - "name": "wait_duration", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'no_timeout'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2697, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Run", - "target": "958" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2698, - "module": "_resource_clients.task", - "name": "get_input", - "parsedDocstring": { - "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "Retrieved task input." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 281 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Retrieved task input." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n" - } - ] - }, - "flags": {}, - "id": 2699, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_input", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2700, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "dict", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2701, - "module": "_resource_clients.task", - "name": "update_input", - "parsedDocstring": { - "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n", - "args": { - "task_input": "The new default input for this task.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated task input." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 303 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated task input." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n" - } - ] - }, - "flags": {}, - "id": 2702, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "update_input", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new default input for this task." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 2703, - "kind": 32768, - "kindString": "Parameter", - "name": "task_input", - "type": { - "name": "TaskInputDict | TaskInput", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict[str, Any]" - }, - { - "type": "reference", - "name": "TaskInput", - "target": "1213" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2704, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "dict", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the runs of this task." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2705, - "module": "_resource_clients.task", - "name": "runs", - "parsedDocstring": { - "text": "Retrieve a client for the runs of this task." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 327 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the runs of this task." - } - ] - }, - "flags": {}, - "id": 2706, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "runs", - "parameters": [], - "type": { - "name": "RunCollectionClient", - "type": "reference", - "target": "3916" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2707, - "module": "_resource_clients.task", - "name": "last_run", - "parsedDocstring": { - "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n", - "args": { - "status": "Consider only runs with this status.", - "origin": "Consider only runs started with this origin.\n" - }, - "returns": "The resource client for the last run of this task." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 334 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The resource client for the last run of this task." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n" - } - ] - }, - "flags": {}, - "id": 2708, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "last_run", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Consider only runs with this status." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2709, - "kind": 32768, - "kindString": "Parameter", - "name": "status", - "type": { - "name": "ActorJobStatus | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorJobStatus", - "target": "1794" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Consider only runs started with this origin.\n" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2710, - "kind": 32768, - "kindString": "Parameter", - "name": "origin", - "type": { - "name": "RunOrigin | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "RunOrigin", - "target": "1799" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "RunClient", - "type": "reference", - "target": "3033" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for webhooks associated with this task." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2711, - "module": "_resource_clients.task", - "name": "webhooks", - "parsedDocstring": { - "text": "Retrieve a client for webhooks associated with this task." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 353 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for webhooks associated with this task." - } - ] - }, - "flags": {}, - "id": 2712, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "webhooks", - "parameters": [], - "type": { - "name": "WebhookCollectionClient", - "type": "reference", - "target": "3794" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 4004, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific task.\n\nProvides methods to manage a specific task, e.g. update it, delete it, or start runs. Obtain an instance via an\nappropriate method on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2649, - 2687, - 2673, - 2654, - 2698, - 2707, - 2705, - 2676, - 2657, - 2701, - 2711 - ], - "title": "Methods" - }, - { - "children": [ - 4004 - ], - "title": "Properties" - } - ], - "id": 2648, - "module": "_resource_clients.task", - "name": "TaskClient", - "parsedDocstring": { - "text": "Sub-client for managing a specific task.\n\nProvides methods to manage a specific task, e.g. update it, delete it, or start runs. Obtain an instance via an\nappropriate method on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 36 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2714, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 366 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2719, - "module": "_resource_clients.task", - "name": "get", - "parsedDocstring": { - "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved task." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 375 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved task." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n" - } - ] - }, - "flags": {}, - "id": 2720, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2721, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Task | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Task", - "target": "1197" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2722, - "module": "_resource_clients.task", - "name": "update", - "parsedDocstring": { - "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n", - "args": { - "name": "Name of the task.", - "build": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest).", - "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit.", - "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.", - "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.", - "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.", - "task_input": "Task input dictionary.", - "title": "A human-friendly equivalent of the name.", - "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.", - "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.", - "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.", - "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.", - "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated task." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 391 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated task." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n" - } - ] - }, - "flags": {}, - "id": 2723, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the task." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2724, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Task input dictionary." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2725, - "kind": 32768, - "kindString": "Parameter", - "name": "task_input", - "type": { - "name": "TaskInputDict | TaskInput | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict[str, Any]" - }, - { - "type": "reference", - "name": "TaskInput", - "target": "1213" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2726, - "kind": 32768, - "kindString": "Parameter", - "name": "build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2727, - "kind": 32768, - "kindString": "Parameter", - "name": "max_items", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2728, - "kind": 32768, - "kindString": "Parameter", - "name": "memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2729, - "kind": 32768, - "kindString": "Parameter", - "name": "run_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2730, - "kind": 32768, - "kindString": "Parameter", - "name": "restart_on_error", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A human-friendly equivalent of the name." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2731, - "kind": 32768, - "kindString": "Parameter", - "name": "title", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2732, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_desired_requests_per_actor_run", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2733, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_max_requests_per_actor_run", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the Actor run does not receive any requests for this time,\nit will be shut down." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2734, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_idle_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The build tag or number to run when the Actor is in Standby mode." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2735, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The memory in megabytes to use when the Actor is in Standby mode." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2736, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2737, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Task", - "type": "reference", - "target": "1197" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2738, - "module": "_resource_clients.task", - "name": "delete", - "parsedDocstring": { - "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 465 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task\n" - } - ] - }, - "flags": {}, - "id": 2739, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2740, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2741, - "module": "_resource_clients.task", - "name": "start", - "parsedDocstring": { - "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n", - "args": { - "task_input": "Task input dictionary.", - "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest).", - "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit.", - "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.", - "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.", - "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.", - "wait_for_finish": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60.", - "webhooks": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The run object." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 475 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The run object." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n" - } - ] - }, - "flags": {}, - "id": 2742, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "start", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Task input dictionary." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2743, - "kind": 32768, - "kindString": "Parameter", - "name": "task_input", - "type": { - "name": "TaskInputDict | TaskInput | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict[str, Any]" - }, - { - "type": "reference", - "name": "TaskInput", - "target": "1213" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2744, - "kind": 32768, - "kindString": "Parameter", - "name": "build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2745, - "kind": 32768, - "kindString": "Parameter", - "name": "max_items", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2746, - "kind": 32768, - "kindString": "Parameter", - "name": "memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2747, - "kind": 32768, - "kindString": "Parameter", - "name": "run_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2748, - "kind": 32768, - "kindString": "Parameter", - "name": "restart_on_error", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2749, - "kind": 32768, - "kindString": "Parameter", - "name": "wait_for_finish", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2750, - "kind": 32768, - "kindString": "Parameter", - "name": "webhooks", - "type": { - "name": "WebhooksList | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "WebhooksList", - "target": "14" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2751, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run", - "type": "reference", - "target": "958" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2752, - "module": "_resource_clients.task", - "name": "call", - "parsedDocstring": { - "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n", - "args": { - "task_input": "Task input dictionary.", - "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest).", - "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit.", - "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.", - "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.", - "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.", - "webhooks": "Specifies optional webhooks associated with the Actor run, which can be used to receive\na notification e.g. when the Actor finished or failed. Note: if you already have a webhook set up for\nthe Actor or task, you do not have to add it again here.", - "wait_duration": "The maximum time the server waits for the task run to finish. If not provided,\nwaits indefinitely.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The run object." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 543 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The run object." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n" - } - ] - }, - "flags": {}, - "id": 2753, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "call", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Task input dictionary." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2754, - "kind": 32768, - "kindString": "Parameter", - "name": "task_input", - "type": { - "name": "TaskInputDict | TaskInput | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict[str, Any]" - }, - { - "type": "reference", - "name": "TaskInput", - "target": "1213" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2755, - "kind": 32768, - "kindString": "Parameter", - "name": "build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2756, - "kind": 32768, - "kindString": "Parameter", - "name": "max_items", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2757, - "kind": 32768, - "kindString": "Parameter", - "name": "memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2758, - "kind": 32768, - "kindString": "Parameter", - "name": "run_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2759, - "kind": 32768, - "kindString": "Parameter", - "name": "restart_on_error", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies optional webhooks associated with the Actor run, which can be used to receive\na notification e.g. when the Actor finished or failed. Note: if you already have a webhook set up for\nthe Actor or task, you do not have to add it again here." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2760, - "kind": 32768, - "kindString": "Parameter", - "name": "webhooks", - "type": { - "name": "WebhooksList | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "WebhooksList", - "target": "14" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum time the server waits for the task run to finish. If not provided,\nwaits indefinitely." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2761, - "kind": 32768, - "kindString": "Parameter", - "name": "wait_duration", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'no_timeout'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2762, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Run", - "target": "958" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2763, - "module": "_resource_clients.task", - "name": "get_input", - "parsedDocstring": { - "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "Retrieved task input." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 603 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "Retrieved task input." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n" - } - ] - }, - "flags": {}, - "id": 2764, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_input", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2765, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "dict", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2766, - "module": "_resource_clients.task", - "name": "update_input", - "parsedDocstring": { - "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n", - "args": { - "task_input": "The new default input for this task.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated task input." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 625 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated task input." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n" - } - ] - }, - "flags": {}, - "id": 2767, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "update_input", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new default input for this task." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 2768, - "kind": 32768, - "kindString": "Parameter", - "name": "task_input", - "type": { - "name": "TaskInputDict | TaskInput", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict[str, Any]" - }, - { - "type": "reference", - "name": "TaskInput", - "target": "1213" - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2769, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "dict", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the runs of this task." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2770, - "module": "_resource_clients.task", - "name": "runs", - "parsedDocstring": { - "text": "Retrieve a client for the runs of this task." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 649 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the runs of this task." - } - ] - }, - "flags": {}, - "id": 2771, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "runs", - "parameters": [], - "type": { - "name": "RunCollectionClientAsync", - "type": "reference", - "target": "3939" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2772, - "module": "_resource_clients.task", - "name": "last_run", - "parsedDocstring": { - "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n", - "args": { - "status": "Consider only runs with this status.", - "origin": "Consider only runs started with this origin.\n" - }, - "returns": "The resource client for the last run of this task." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 656 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The resource client for the last run of this task." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n" - } - ] - }, - "flags": {}, - "id": 2773, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "last_run", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Consider only runs with this status." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2774, - "kind": 32768, - "kindString": "Parameter", - "name": "status", - "type": { - "name": "ActorJobStatus | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorJobStatus", - "target": "1794" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Consider only runs started with this origin.\n" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2775, - "kind": 32768, - "kindString": "Parameter", - "name": "origin", - "type": { - "name": "RunOrigin | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "RunOrigin", - "target": "1799" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "RunClientAsync", - "type": "reference", - "target": "3102" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for webhooks associated with this task." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2776, - "module": "_resource_clients.task", - "name": "webhooks", - "parsedDocstring": { - "text": "Retrieve a client for webhooks associated with this task." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 675 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for webhooks associated with this task." - } - ] - }, - "flags": {}, - "id": 2777, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "webhooks", - "parameters": [], - "type": { - "name": "WebhookCollectionClientAsync", - "type": "reference", - "target": "3825" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3977, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific task.\n\nProvides methods to manage a specific task, e.g. update it, delete it, or start runs. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2714, - 2752, - 2738, - 2719, - 2763, - 2772, - 2770, - 2741, - 2722, - 2766, - 2776 - ], - "title": "Methods" - }, - { - "children": [ - 3977 - ], - "title": "Properties" - } - ], - "id": 2713, - "module": "_resource_clients.task", - "name": "TaskClientAsync", - "parsedDocstring": { - "text": "Sub-client for managing a specific task.\n\nProvides methods to manage a specific task, e.g. update it, delete it, or start runs. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/task.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 359 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2779, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 25 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2783, - "module": "_resource_clients.build_collection", - "name": "list", - "parsedDocstring": { - "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n", - "args": { - "limit": "How many builds to retrieve.", - "offset": "What build to include as first when retrieving the list.", - "desc": "Whether to sort the builds in descending order based on their start date.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved Actor builds." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 36 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved Actor builds." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n" - } - ] - }, - "flags": {}, - "id": 2784, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many builds to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2785, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What build to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2786, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the builds in descending order based on their start date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2787, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2788, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfBuilds", - "type": "reference", - "target": "756" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over all Actor builds.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2789, - "module": "_resource_clients.build_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over all Actor builds.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n", - "args": { - "limit": "How many builds to retrieve.", - "offset": "What build to include as first when retrieving the list.", - "desc": "Whether to sort the builds in descending order based on their start date.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 64 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over all Actor builds.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n" - } - ] - }, - "flags": {}, - "id": 2790, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many builds to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2791, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What build to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2792, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the builds in descending order based on their start date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2793, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2794, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "BuildShort", - "target": "333" - } - ] - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 4005, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the Actor build collection.\n\nProvides methods to manage Actor builds, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2779, - 2789, - 2783 - ], - "title": "Methods" - }, - { - "children": [ - 4005 - ], - "title": "Properties" - } - ], - "id": 2778, - "module": "_resource_clients.build_collection", - "name": "BuildCollectionClient", - "parsedDocstring": { - "text": "Sub-client for the Actor build collection.\n\nProvides methods to manage Actor builds, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 18 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2796, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 104 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2800, - "module": "_resource_clients.build_collection", - "name": "list", - "parsedDocstring": { - "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n", - "args": { - "limit": "How many builds to retrieve.", - "offset": "What build to include as first when retrieving the list.", - "desc": "Whether to sort the builds in descending order based on their start date.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved Actor builds." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 115 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved Actor builds." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n" - } - ] - }, - "flags": {}, - "id": 2801, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many builds to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2802, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What build to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2803, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the builds in descending order based on their start date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2804, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2805, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfBuilds", - "type": "reference", - "target": "756" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over all Actor builds.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2806, - "module": "_resource_clients.build_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over all Actor builds.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n", - "args": { - "limit": "How many builds to retrieve.", - "offset": "What build to include as first when retrieving the list.", - "desc": "Whether to sort the builds in descending order based on their start date.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 143 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over all Actor builds.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n" - } - ] - }, - "flags": {}, - "id": 2807, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many builds to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2808, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What build to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2809, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the builds in descending order based on their start date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2810, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2811, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "BuildShort", - "target": "333" - } - ] - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3978, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the Actor build collection.\n\nProvides methods to manage Actor builds, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2796, - 2806, - 2800 - ], - "title": "Methods" - }, - { - "children": [ - 3978 - ], - "title": "Properties" - } - ], - "id": 2795, - "module": "_resource_clients.build_collection", - "name": "BuildCollectionClientAsync", - "parsedDocstring": { - "text": "Sub-client for the Actor build collection.\n\nProvides methods to manage Actor builds, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 97 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of dataset items. Each item is a JSON object (dictionary)." - } - ] - }, - "flags": {}, - "groups": [], - "id": 2813, - "module": "_resource_clients.dataset", - "name": "items", - "parsedDocstring": { - "text": "List of dataset items. Each item is a JSON object (dictionary)." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 37 - } - ], - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Total number of items in the dataset." - } - ] - }, - "flags": {}, - "groups": [], - "id": 2814, - "module": "_resource_clients.dataset", - "name": "total", - "parsedDocstring": { - "text": "Total number of items in the dataset." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 40 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The offset of the first item in this page." - } - ] - }, - "flags": {}, - "groups": [], - "id": 2815, - "module": "_resource_clients.dataset", - "name": "offset", - "parsedDocstring": { - "text": "The offset of the first item in this page." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 43 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of items in this page." - } - ] - }, - "flags": {}, - "groups": [], - "id": 2816, - "module": "_resource_clients.dataset", - "name": "count", - "parsedDocstring": { - "text": "Number of items in this page." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 46 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "The limit that was used for this request." - } - ] - }, - "flags": {}, - "groups": [], - "id": 2817, - "module": "_resource_clients.dataset", - "name": "limit", - "parsedDocstring": { - "text": "The limit that was used for this request." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 49 - } - ], - "type": { - "name": "int", - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the items are sorted in descending order." - } - ] - }, - "flags": {}, - "groups": [], - "id": 2818, - "module": "_resource_clients.dataset", - "name": "desc", - "parsedDocstring": { - "text": "Whether the items are sorted in descending order." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 52 - } - ], - "type": { - "name": "bool", - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "A page of dataset items returned by the `list_items` method.\n\nDataset items are arbitrary JSON objects stored in the dataset, so they cannot be\nrepresented by a specific Pydantic model. This class provides pagination metadata\nalong with the raw items." - } - ] - }, - "decorations": [ - { - "args": "('Other')", - "name": "docs_group" - }, - { - "name": "dataclass" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2816, - 2818, - 2813, - 2817, - 2815, - 2814 - ], - "title": "Properties" - } - ], - "id": 2812, - "module": "_resource_clients.dataset", - "name": "DatasetItemsPage", - "parsedDocstring": { - "text": "A page of dataset items returned by the `list_items` method.\n\nDataset items are arbitrary JSON objects stored in the dataset, so they cannot be\nrepresented by a specific Pydantic model. This class provides pagination metadata\nalong with the raw items." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 29 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - } - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2820, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 64 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2825, - "module": "_resource_clients.dataset", - "name": "get", - "parsedDocstring": { - "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved dataset, or None, if it does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 77 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved dataset, or None, if it does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n" - } - ] - }, - "flags": {}, - "id": 2826, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2827, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Dataset | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Dataset", - "target": "432" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2828, - "module": "_resource_clients.dataset", - "name": "update", - "parsedDocstring": { - "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n", - "args": { - "name": "The new name for the dataset.", - "general_access": "Determines how others can access the dataset.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated dataset." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 93 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated dataset." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n" - } - ] - }, - "flags": {}, - "id": 2829, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new name for the dataset." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2830, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines how others can access the dataset." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2831, - "kind": 32768, - "kindString": "Parameter", - "name": "general_access", - "type": { - "name": "GeneralAccess | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "GeneralAccess", - "target": "1797" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2832, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Dataset", - "type": "reference", - "target": "432" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2833, - "module": "_resource_clients.dataset", - "name": "delete", - "parsedDocstring": { - "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 119 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset\n" - } - ] - }, - "flags": {}, - "id": 2834, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2835, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2836, - "module": "_resource_clients.dataset", - "name": "list_items", - "parsedDocstring": { - "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n", - "args": { - "offset": "Number of items that should be skipped at the start. The default value is 0.", - "limit": "Maximum number of items to return. By default there is no limit.", - "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", - "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.", - "fields": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.", - "omit": "A list of fields which should be omitted from the items.", - "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.", - "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.", - "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.", - "flatten": "A list of fields that should be flattened.", - "view": "Name of the dataset view to be used.", - "signature": "Signature used to access the items.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "A page of the list of dataset items according to the specified filters." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 129 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A page of the list of dataset items according to the specified filters." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" - } - ] - }, - "flags": {}, - "id": 2837, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "list_items", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of items that should be skipped at the start. The default value is 0." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2838, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items to return. By default there is no limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2839, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2840, - "kind": 32768, - "kindString": "Parameter", - "name": "clean", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2841, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2842, - "kind": 32768, - "kindString": "Parameter", - "name": "fields", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be omitted from the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2843, - "kind": 32768, - "kindString": "Parameter", - "name": "omit", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2844, - "kind": 32768, - "kindString": "Parameter", - "name": "unwind", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2845, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_empty", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2846, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_hidden", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields that should be flattened." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2847, - "kind": 32768, - "kindString": "Parameter", - "name": "flatten", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the dataset view to be used." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2848, - "kind": 32768, - "kindString": "Parameter", - "name": "view", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signature used to access the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2849, - "kind": 32768, - "kindString": "Parameter", - "name": "signature", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2850, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "DatasetItemsPage", - "type": "reference", - "target": "2812" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the items in the dataset.\n\nSimple `list_items` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2851, - "module": "_resource_clients.dataset", - "name": "iterate_items", - "parsedDocstring": { - "text": "Iterate over the items in the dataset.\n\nSimple `list_items` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n", - "args": { - "offset": "Number of items that should be skipped at the start. The default value is 0.", - "limit": "Maximum number of items to return. By default there is no limit.", - "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", - "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.", - "fields": "A list of fields which should be picked from the items, only these fields will remain in\nthe resulting record objects. Note that the fields in the outputted items are sorted the same way\nas they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.", - "omit": "A list of fields which should be omitted from the items.", - "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.", - "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.", - "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.", - "signature": "Signature used to access the items.", - "chunk_size": "Maximum number of items requested per API call when iterating across pages.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 219 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the items in the dataset.\n\nSimple `list_items` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" - } - ] - }, - "flags": {}, - "id": 2852, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate_items", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of items that should be skipped at the start. The default value is 0." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2853, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items to return. By default there is no limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2854, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2855, - "kind": 32768, - "kindString": "Parameter", - "name": "clean", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2856, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be picked from the items, only these fields will remain in\nthe resulting record objects. Note that the fields in the outputted items are sorted the same way\nas they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2857, - "kind": 32768, - "kindString": "Parameter", - "name": "fields", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be omitted from the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2858, - "kind": 32768, - "kindString": "Parameter", - "name": "omit", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2859, - "kind": 32768, - "kindString": "Parameter", - "name": "unwind", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2860, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_empty", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2861, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_hidden", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signature used to access the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2862, - "kind": 32768, - "kindString": "Parameter", - "name": "signature", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items requested per API call when iterating across pages." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2863, - "kind": 32768, - "kindString": "Parameter", - "name": "chunk_size", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2864, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "dict" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2865, - "module": "_resource_clients.dataset", - "name": "get_items_as_bytes", - "parsedDocstring": { - "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n", - "args": { - "item_format": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json.", - "offset": "Number of items that should be skipped at the start. The default value is 0.", - "limit": "Maximum number of items to return. By default there is no limit.", - "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", - "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.", - "bom": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it.", - "delimiter": "A delimiter character for CSV files. The default delimiter is a simple comma (,).", - "fields": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format.", - "omit": "A list of fields which should be omitted from the items.", - "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.", - "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.", - "skip_header_row": "If True, then header row in the csv format is skipped.", - "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.", - "xml_root": "Overrides default root element name of xml output. By default the root element is items.", - "xml_row": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item.", - "flatten": "A list of fields that should be flattened.", - "signature": "Signature used to access the items.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The dataset items as raw bytes." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 291 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The dataset items as raw bytes." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" - } - ] - }, - "flags": {}, - "id": 2866, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_items_as_bytes", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json." - } - ] - }, - "defaultValue": "'json'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2867, - "kind": 32768, - "kindString": "Parameter", - "name": "item_format", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of items that should be skipped at the start. The default value is 0." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2868, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items to return. By default there is no limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2869, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2870, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2871, - "kind": 32768, - "kindString": "Parameter", - "name": "clean", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2872, - "kind": 32768, - "kindString": "Parameter", - "name": "bom", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A delimiter character for CSV files. The default delimiter is a simple comma (,)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2873, - "kind": 32768, - "kindString": "Parameter", - "name": "delimiter", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2874, - "kind": 32768, - "kindString": "Parameter", - "name": "fields", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be omitted from the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2875, - "kind": 32768, - "kindString": "Parameter", - "name": "omit", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2876, - "kind": 32768, - "kindString": "Parameter", - "name": "unwind", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2877, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_empty", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then header row in the csv format is skipped." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2878, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_header_row", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2879, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_hidden", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Overrides default root element name of xml output. By default the root element is items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2880, - "kind": 32768, - "kindString": "Parameter", - "name": "xml_root", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2881, - "kind": 32768, - "kindString": "Parameter", - "name": "xml_row", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields that should be flattened." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2882, - "kind": 32768, - "kindString": "Parameter", - "name": "flatten", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signature used to access the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2883, - "kind": 32768, - "kindString": "Parameter", - "name": "signature", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2884, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "bytes", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" - } - ] - }, - "decorations": [ - { - "name": "contextmanager" - } - ], - "flags": {}, - "groups": [], - "id": 2885, - "module": "_resource_clients.dataset", - "name": "stream_items", - "parsedDocstring": { - "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n", - "args": { - "item_format": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json.", - "offset": "Number of items that should be skipped at the start. The default value is 0.", - "limit": "Maximum number of items to return. By default there is no limit.", - "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", - "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.", - "bom": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it.", - "delimiter": "A delimiter character for CSV files. The default delimiter is a simple comma (,).", - "fields": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format.", - "omit": "A list of fields which should be omitted from the items.", - "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.", - "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.", - "skip_header_row": "If True, then header row in the csv format is skipped.", - "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.", - "xml_root": "Overrides default root element name of xml output. By default the root element is items.", - "xml_row": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item.", - "signature": "Signature used to access the items.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The dataset items as a context-managed streaming `Response`." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 390 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The dataset items as a context-managed streaming `Response`." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" - } - ] - }, - "flags": {}, - "id": 2886, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "stream_items", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json." - } - ] - }, - "defaultValue": "'json'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2887, - "kind": 32768, - "kindString": "Parameter", - "name": "item_format", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of items that should be skipped at the start. The default value is 0." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2888, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items to return. By default there is no limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2889, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2890, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2891, - "kind": 32768, - "kindString": "Parameter", - "name": "clean", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2892, - "kind": 32768, - "kindString": "Parameter", - "name": "bom", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A delimiter character for CSV files. The default delimiter is a simple comma (,)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2893, - "kind": 32768, - "kindString": "Parameter", - "name": "delimiter", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2894, - "kind": 32768, - "kindString": "Parameter", - "name": "fields", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be omitted from the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2895, - "kind": 32768, - "kindString": "Parameter", - "name": "omit", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2896, - "kind": 32768, - "kindString": "Parameter", - "name": "unwind", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2897, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_empty", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then header row in the csv format is skipped." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2898, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_header_row", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2899, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_hidden", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Overrides default root element name of xml output. By default the root element is items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2900, - "kind": 32768, - "kindString": "Parameter", - "name": "xml_root", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2901, - "kind": 32768, - "kindString": "Parameter", - "name": "xml_row", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signature used to access the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2902, - "kind": 32768, - "kindString": "Parameter", - "name": "signature", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2903, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "HttpResponse", - "target": "1805" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2904, - "module": "_resource_clients.dataset", - "name": "push_items", - "parsedDocstring": { - "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n", - "args": { - "items": "The items which to push in the dataset. Either a stringified JSON, a dictionary, or a list\nof strings or dictionaries.", - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 490 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n" - } - ] - }, - "flags": {}, - "id": 2905, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "push_items", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The items which to push in the dataset. Either a stringified JSON, a dictionary, or a list\nof strings or dictionaries." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 2906, - "kind": 32768, - "kindString": "Parameter", - "name": "items", - "type": { - "name": "JsonSerializable", - "type": "reference", - "target": "15" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2907, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2908, - "module": "_resource_clients.dataset", - "name": "get_statistics", - "parsedDocstring": { - "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The dataset statistics." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 518 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The dataset statistics." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n" - } - ] - }, - "flags": {}, - "id": 2909, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_statistics", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2910, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "DatasetStatistics", - "type": "reference", - "target": "477" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2911, - "module": "_resource_clients.dataset", - "name": "create_items_public_url", - "parsedDocstring": { - "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n", - "args": { - "offset": "Number of items that should be skipped at the start. The default value is 0.", - "limit": "Maximum number of items to return. By default there is no limit.", - "clean": "If True, returns only non-empty items and skips hidden fields.", - "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", - "fields": "A list of fields which should be picked from the items.", - "omit": "A list of fields which should be omitted from the items.", - "unwind": "A list of fields which should be unwound, in order which they should be processed.", - "skip_empty": "If True, then empty items are skipped from the output.", - "skip_hidden": "If True, then hidden fields are skipped from the output.", - "flatten": "A list of fields that should be flattened.", - "view": "Name of the dataset view to be used.", - "expires_in": "How long the signed URL should be valid.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The public dataset items URL." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 541 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The public dataset items URL." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n" - } - ] - }, - "flags": {}, - "id": 2912, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "create_items_public_url", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of items that should be skipped at the start. The default value is 0." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2913, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items to return. By default there is no limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2914, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, returns only non-empty items and skips hidden fields." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2915, - "kind": 32768, - "kindString": "Parameter", - "name": "clean", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2916, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be picked from the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2917, - "kind": 32768, - "kindString": "Parameter", - "name": "fields", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be omitted from the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2918, - "kind": 32768, - "kindString": "Parameter", - "name": "omit", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be unwound, in order which they should be processed." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2919, - "kind": 32768, - "kindString": "Parameter", - "name": "unwind", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then empty items are skipped from the output." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2920, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_empty", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then hidden fields are skipped from the output." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2921, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_hidden", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields that should be flattened." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2922, - "kind": 32768, - "kindString": "Parameter", - "name": "flatten", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the dataset view to be used." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2923, - "kind": 32768, - "kindString": "Parameter", - "name": "view", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How long the signed URL should be valid." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2924, - "kind": 32768, - "kindString": "Parameter", - "name": "expires_in", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2925, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "str", - "type": "reference" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 4006, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific dataset.\n\nProvides methods to manage a specific dataset, e.g. get it, update it, or download its items. Obtain an instance\nvia an appropriate method on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2820, - 2911, - 2833, - 2825, - 2865, - 2908, - 2851, - 2836, - 2904, - 2885, - 2828 - ], - "title": "Methods" - }, - { - "children": [ - 4006 - ], - "title": "Properties" - } - ], - "id": 2819, - "module": "_resource_clients.dataset", - "name": "DatasetClient", - "parsedDocstring": { - "text": "Sub-client for managing a specific dataset.\n\nProvides methods to manage a specific dataset, e.g. get it, update it, or download its items. Obtain an instance\nvia an appropriate method on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 57 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2927, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 628 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2932, - "module": "_resource_clients.dataset", - "name": "get", - "parsedDocstring": { - "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved dataset, or None, if it does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 641 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved dataset, or None, if it does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n" - } - ] - }, - "flags": {}, - "id": 2933, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2934, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Dataset | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Dataset", - "target": "432" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2935, - "module": "_resource_clients.dataset", - "name": "update", - "parsedDocstring": { - "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n", - "args": { - "name": "The new name for the dataset.", - "general_access": "Determines how others can access the dataset.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated dataset." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 657 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated dataset." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n" - } - ] - }, - "flags": {}, - "id": 2936, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new name for the dataset." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2937, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines how others can access the dataset." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2938, - "kind": 32768, - "kindString": "Parameter", - "name": "general_access", - "type": { - "name": "GeneralAccess | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "GeneralAccess", - "target": "1797" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2939, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Dataset", - "type": "reference", - "target": "432" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2940, - "module": "_resource_clients.dataset", - "name": "delete", - "parsedDocstring": { - "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 683 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset\n" - } - ] - }, - "flags": {}, - "id": 2941, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2942, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2943, - "module": "_resource_clients.dataset", - "name": "list_items", - "parsedDocstring": { - "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n", - "args": { - "offset": "Number of items that should be skipped at the start. The default value is 0.", - "limit": "Maximum number of items to return. By default there is no limit.", - "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", - "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.", - "fields": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.", - "omit": "A list of fields which should be omitted from the items.", - "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.", - "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.", - "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.", - "flatten": "A list of fields that should be flattened.", - "view": "Name of the dataset view to be used.", - "signature": "Signature used to access the items.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "A page of the list of dataset items according to the specified filters." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 693 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A page of the list of dataset items according to the specified filters." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" - } - ] - }, - "flags": {}, - "id": 2944, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "list_items", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of items that should be skipped at the start. The default value is 0." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2945, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items to return. By default there is no limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2946, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2947, - "kind": 32768, - "kindString": "Parameter", - "name": "clean", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2948, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2949, - "kind": 32768, - "kindString": "Parameter", - "name": "fields", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be omitted from the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2950, - "kind": 32768, - "kindString": "Parameter", - "name": "omit", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2951, - "kind": 32768, - "kindString": "Parameter", - "name": "unwind", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2952, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_empty", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2953, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_hidden", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields that should be flattened." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2954, - "kind": 32768, - "kindString": "Parameter", - "name": "flatten", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the dataset view to be used." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2955, - "kind": 32768, - "kindString": "Parameter", - "name": "view", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signature used to access the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2956, - "kind": 32768, - "kindString": "Parameter", - "name": "signature", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2957, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "DatasetItemsPage", - "type": "reference", - "target": "2812" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the items in the dataset.\n\nSimple `list_items` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2958, - "module": "_resource_clients.dataset", - "name": "iterate_items", - "parsedDocstring": { - "text": "Iterate over the items in the dataset.\n\nSimple `list_items` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n", - "args": { - "offset": "Number of items that should be skipped at the start. The default value is 0.", - "limit": "Maximum number of items to return. By default there is no limit.", - "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", - "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.", - "fields": "A list of fields which should be picked from the items, only these fields will remain in\nthe resulting record objects. Note that the fields in the outputted items are sorted the same way\nas they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.", - "omit": "A list of fields which should be omitted from the items.", - "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.", - "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.", - "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.", - "signature": "Signature used to access the items.", - "chunk_size": "Maximum number of items requested per API call when iterating across pages.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 783 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the items in the dataset.\n\nSimple `list_items` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" - } - ] - }, - "flags": {}, - "id": 2959, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate_items", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of items that should be skipped at the start. The default value is 0." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2960, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items to return. By default there is no limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2961, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2962, - "kind": 32768, - "kindString": "Parameter", - "name": "clean", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2963, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be picked from the items, only these fields will remain in\nthe resulting record objects. Note that the fields in the outputted items are sorted the same way\nas they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2964, - "kind": 32768, - "kindString": "Parameter", - "name": "fields", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be omitted from the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2965, - "kind": 32768, - "kindString": "Parameter", - "name": "omit", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2966, - "kind": 32768, - "kindString": "Parameter", - "name": "unwind", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2967, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_empty", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2968, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_hidden", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signature used to access the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2969, - "kind": 32768, - "kindString": "Parameter", - "name": "signature", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items requested per API call when iterating across pages." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2970, - "kind": 32768, - "kindString": "Parameter", - "name": "chunk_size", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2971, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "dict" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 2972, - "module": "_resource_clients.dataset", - "name": "get_items_as_bytes", - "parsedDocstring": { - "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n", - "args": { - "item_format": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json.", - "offset": "Number of items that should be skipped at the start. The default value is 0.", - "limit": "Maximum number of items to return. By default there is no limit.", - "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", - "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.", - "bom": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it.", - "delimiter": "A delimiter character for CSV files. The default delimiter is a simple comma (,).", - "fields": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format.", - "omit": "A list of fields which should be omitted from the items.", - "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.", - "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.", - "skip_header_row": "If True, then header row in the csv format is skipped.", - "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.", - "xml_root": "Overrides default root element name of xml output. By default the root element is items.", - "xml_row": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item.", - "flatten": "A list of fields that should be flattened.", - "signature": "Signature used to access the items.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The dataset items as raw bytes." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 857 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The dataset items as raw bytes." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" - } - ] - }, - "flags": {}, - "id": 2973, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_items_as_bytes", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json." - } - ] - }, - "defaultValue": "'json'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2974, - "kind": 32768, - "kindString": "Parameter", - "name": "item_format", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of items that should be skipped at the start. The default value is 0." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2975, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items to return. By default there is no limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2976, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2977, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2978, - "kind": 32768, - "kindString": "Parameter", - "name": "clean", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2979, - "kind": 32768, - "kindString": "Parameter", - "name": "bom", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A delimiter character for CSV files. The default delimiter is a simple comma (,)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2980, - "kind": 32768, - "kindString": "Parameter", - "name": "delimiter", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2981, - "kind": 32768, - "kindString": "Parameter", - "name": "fields", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be omitted from the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2982, - "kind": 32768, - "kindString": "Parameter", - "name": "omit", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2983, - "kind": 32768, - "kindString": "Parameter", - "name": "unwind", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2984, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_empty", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then header row in the csv format is skipped." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2985, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_header_row", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2986, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_hidden", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Overrides default root element name of xml output. By default the root element is items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2987, - "kind": 32768, - "kindString": "Parameter", - "name": "xml_root", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2988, - "kind": 32768, - "kindString": "Parameter", - "name": "xml_row", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields that should be flattened." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2989, - "kind": 32768, - "kindString": "Parameter", - "name": "flatten", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signature used to access the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2990, - "kind": 32768, - "kindString": "Parameter", - "name": "signature", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2991, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "bytes", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" - } - ] - }, - "decorations": [ - { - "name": "asynccontextmanager" - } - ], - "flags": {}, - "groups": [], - "id": 2992, - "module": "_resource_clients.dataset", - "name": "stream_items", - "parsedDocstring": { - "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n", - "args": { - "item_format": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json.", - "offset": "Number of items that should be skipped at the start. The default value is 0.", - "limit": "Maximum number of items to return. By default there is no limit.", - "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", - "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.", - "bom": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it.", - "delimiter": "A delimiter character for CSV files. The default delimiter is a simple comma (,).", - "fields": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format.", - "omit": "A list of fields which should be omitted from the items.", - "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.", - "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.", - "skip_header_row": "If True, then header row in the csv format is skipped.", - "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.", - "xml_root": "Overrides default root element name of xml output. By default the root element is items.", - "xml_row": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item.", - "signature": "Signature used to access the items.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The dataset items as a context-managed streaming `Response`." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 956 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The dataset items as a context-managed streaming `Response`." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" - } - ] - }, - "flags": {}, - "id": 2993, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "stream_items", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json." - } - ] - }, - "defaultValue": "'json'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2994, - "kind": 32768, - "kindString": "Parameter", - "name": "item_format", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of items that should be skipped at the start. The default value is 0." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2995, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items to return. By default there is no limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2996, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2997, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2998, - "kind": 32768, - "kindString": "Parameter", - "name": "clean", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 2999, - "kind": 32768, - "kindString": "Parameter", - "name": "bom", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A delimiter character for CSV files. The default delimiter is a simple comma (,)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3000, - "kind": 32768, - "kindString": "Parameter", - "name": "delimiter", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3001, - "kind": 32768, - "kindString": "Parameter", - "name": "fields", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be omitted from the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3002, - "kind": 32768, - "kindString": "Parameter", - "name": "omit", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3003, - "kind": 32768, - "kindString": "Parameter", - "name": "unwind", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3004, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_empty", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then header row in the csv format is skipped." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3005, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_header_row", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3006, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_hidden", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Overrides default root element name of xml output. By default the root element is items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3007, - "kind": 32768, - "kindString": "Parameter", - "name": "xml_root", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3008, - "kind": 32768, - "kindString": "Parameter", - "name": "xml_row", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signature used to access the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3009, - "kind": 32768, - "kindString": "Parameter", - "name": "signature", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3010, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "HttpResponse", - "target": "1805" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3011, - "module": "_resource_clients.dataset", - "name": "push_items", - "parsedDocstring": { - "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n", - "args": { - "items": "The items which to push in the dataset. Either a stringified JSON, a dictionary, or a list\nof strings or dictionaries.", - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1056 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n" - } - ] - }, - "flags": {}, - "id": 3012, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "push_items", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The items which to push in the dataset. Either a stringified JSON, a dictionary, or a list\nof strings or dictionaries." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3013, - "kind": 32768, - "kindString": "Parameter", - "name": "items", - "type": { - "name": "JsonSerializable", - "type": "reference", - "target": "15" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3014, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3015, - "module": "_resource_clients.dataset", - "name": "get_statistics", - "parsedDocstring": { - "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The dataset statistics." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1084 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The dataset statistics." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n" - } - ] - }, - "flags": {}, - "id": 3016, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_statistics", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3017, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "DatasetStatistics", - "type": "reference", - "target": "477" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3018, - "module": "_resource_clients.dataset", - "name": "create_items_public_url", - "parsedDocstring": { - "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n", - "args": { - "offset": "Number of items that should be skipped at the start. The default value is 0.", - "limit": "Maximum number of items to return. By default there is no limit.", - "clean": "If True, returns only non-empty items and skips hidden fields.", - "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", - "fields": "A list of fields which should be picked from the items.", - "omit": "A list of fields which should be omitted from the items.", - "unwind": "A list of fields which should be unwound, in order which they should be processed.", - "skip_empty": "If True, then empty items are skipped from the output.", - "skip_hidden": "If True, then hidden fields are skipped from the output.", - "flatten": "A list of fields that should be flattened.", - "view": "Name of the dataset view to be used.", - "expires_in": "How long the signed URL should be valid.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The public dataset items URL." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1107 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The public dataset items URL." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n" - } - ] - }, - "flags": {}, - "id": 3019, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "create_items_public_url", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of items that should be skipped at the start. The default value is 0." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3020, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items to return. By default there is no limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3021, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, returns only non-empty items and skips hidden fields." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3022, - "kind": 32768, - "kindString": "Parameter", - "name": "clean", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3023, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be picked from the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3024, - "kind": 32768, - "kindString": "Parameter", - "name": "fields", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be omitted from the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3025, - "kind": 32768, - "kindString": "Parameter", - "name": "omit", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields which should be unwound, in order which they should be processed." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3026, - "kind": 32768, - "kindString": "Parameter", - "name": "unwind", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then empty items are skipped from the output." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3027, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_empty", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then hidden fields are skipped from the output." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3028, - "kind": 32768, - "kindString": "Parameter", - "name": "skip_hidden", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of fields that should be flattened." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3029, - "kind": 32768, - "kindString": "Parameter", - "name": "flatten", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the dataset view to be used." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3030, - "kind": 32768, - "kindString": "Parameter", - "name": "view", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How long the signed URL should be valid." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3031, - "kind": 32768, - "kindString": "Parameter", - "name": "expires_in", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3032, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "str", - "type": "reference" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3979, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific dataset.\n\nProvides methods to manage a specific dataset, e.g. get it, update it, or download its items. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 2927, - 3018, - 2940, - 2932, - 2972, - 3015, - 2958, - 2943, - 3011, - 2992, - 2935 - ], - "title": "Methods" - }, - { - "children": [ - 3979 - ], - "title": "Properties" - } - ], - "id": 2926, - "module": "_resource_clients.dataset", - "name": "DatasetClientAsync", - "parsedDocstring": { - "text": "Sub-client for managing a specific dataset.\n\nProvides methods to manage a specific dataset, e.g. get it, update it, or download its items. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 621 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3034, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 44 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3039, - "module": "_resource_clients.run", - "name": "get", - "parsedDocstring": { - "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved Actor run data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 57 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved Actor run data." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n" - } - ] - }, - "flags": {}, - "id": 3040, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3041, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Run", - "target": "958" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3042, - "module": "_resource_clients.run", - "name": "update", - "parsedDocstring": { - "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n", - "args": { - "status_message": "The new status message for the run.", - "is_status_message_terminal": "Set this flag to True if this is the final status message of the Actor run.", - "general_access": "Determines how others can access the run and its storages.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 73 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated run." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n" - } - ] - }, - "flags": {}, - "id": 3043, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new status message for the run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3044, - "kind": 32768, - "kindString": "Parameter", - "name": "status_message", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this flag to True if this is the final status message of the Actor run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3045, - "kind": 32768, - "kindString": "Parameter", - "name": "is_status_message_terminal", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines how others can access the run and its storages." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3046, - "kind": 32768, - "kindString": "Parameter", - "name": "general_access", - "type": { - "name": "GeneralAccess | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "GeneralAccess", - "target": "1797" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3047, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run", - "type": "reference", - "target": "958" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3048, - "module": "_resource_clients.run", - "name": "delete", - "parsedDocstring": { - "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 102 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run\n" - } - ] - }, - "flags": {}, - "id": 3049, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3050, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3051, - "module": "_resource_clients.run", - "name": "abort", - "parsedDocstring": { - "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n", - "args": { - "gracefully": "If True, the Actor run will abort gracefully. It will send `aborting` and `persistStates`\nevents into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\nto resurrect the run later.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The data of the aborted Actor run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 112 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The data of the aborted Actor run." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n" - } - ] - }, - "flags": {}, - "id": 3052, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "abort", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, the Actor run will abort gracefully. It will send `aborting` and `persistStates`\nevents into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\nto resurrect the run later." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3053, - "kind": 32768, - "kindString": "Parameter", - "name": "gracefully", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3054, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run", - "type": "reference", - "target": "958" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wait synchronously until the run finishes or the server times out.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3055, - "module": "_resource_clients.run", - "name": "wait_for_finish", - "parsedDocstring": { - "text": "Wait synchronously until the run finishes or the server times out.\n", - "args": { - "wait_duration": "How long does the client wait for run to finish. None for indefinite.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The Actor run data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the run has not yet finished." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 135 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The Actor run data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the run has not yet finished." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Wait synchronously until the run finishes or the server times out.\n" - } - ] - }, - "flags": {}, - "id": 3056, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "wait_for_finish", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How long does the client wait for run to finish. None for indefinite." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3057, - "kind": 32768, - "kindString": "Parameter", - "name": "wait_duration", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'no_timeout'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3058, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Run", - "target": "958" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3059, - "module": "_resource_clients.run", - "name": "metamorph", - "parsedDocstring": { - "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n", - "args": { - "target_actor_id": "ID of the target Actor that the run should be transformed into.", - "target_actor_build": "The build of the target Actor. It can be either a build tag or build number.\nBy default, the run uses the build specified in the default run configuration for the target Actor\n(typically the latest build).", - "run_input": "The input to pass to the new run.", - "content_type": "The content type of the input.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The Actor run data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 163 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The Actor run data." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n" - } - ] - }, - "flags": {}, - "id": 3060, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "metamorph", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the target Actor that the run should be transformed into." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3061, - "kind": 32768, - "kindString": "Parameter", - "name": "target_actor_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The build of the target Actor. It can be either a build tag or build number.\nBy default, the run uses the build specified in the default run configuration for the target Actor\n(typically the latest build)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3062, - "kind": 32768, - "kindString": "Parameter", - "name": "target_actor_build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The input to pass to the new run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3063, - "kind": 32768, - "kindString": "Parameter", - "name": "run_input", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type of the input." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3064, - "kind": 32768, - "kindString": "Parameter", - "name": "content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3065, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run", - "type": "reference", - "target": "958" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3066, - "module": "_resource_clients.run", - "name": "resurrect", - "parsedDocstring": { - "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n", - "args": { - "build": "Which Actor build the resurrected run should use. It can be either a build tag or build number.\nBy default, the resurrected run uses the same build as before.", - "memory_mbytes": "New memory limit for the resurrected run, in megabytes. By default, the resurrected run\nuses the same memory limit as before.", - "run_timeout": "New timeout for the resurrected run. By default, the resurrected run uses the\nsame timeout as before.", - "max_items": "Maximum number of items that the resurrected pay-per-result run will return. By default, the\nresurrected run uses the same limit as before. Limit can be only increased.", - "max_total_charge_usd": "Maximum cost for the resurrected pay-per-event run in USD. By default, the\nresurrected run uses the same limit as before. Limit can be only increased.", - "restart_on_error": "Determines whether the resurrected run will be restarted if it fails.\nBy default, the resurrected run uses the same setting as before.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The Actor run data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 206 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The Actor run data." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n" - } - ] - }, - "flags": {}, - "id": 3067, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "resurrect", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Which Actor build the resurrected run should use. It can be either a build tag or build number.\nBy default, the resurrected run uses the same build as before." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3068, - "kind": 32768, - "kindString": "Parameter", - "name": "build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "New memory limit for the resurrected run, in megabytes. By default, the resurrected run\nuses the same memory limit as before." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3069, - "kind": 32768, - "kindString": "Parameter", - "name": "memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "New timeout for the resurrected run. By default, the resurrected run uses the\nsame timeout as before." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3070, - "kind": 32768, - "kindString": "Parameter", - "name": "run_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items that the resurrected pay-per-result run will return. By default, the\nresurrected run uses the same limit as before. Limit can be only increased." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3071, - "kind": 32768, - "kindString": "Parameter", - "name": "max_items", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum cost for the resurrected pay-per-event run in USD. By default, the\nresurrected run uses the same limit as before. Limit can be only increased." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3072, - "kind": 32768, - "kindString": "Parameter", - "name": "max_total_charge_usd", - "type": { - "name": "Decimal | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Decimal" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines whether the resurrected run will be restarted if it fails.\nBy default, the resurrected run uses the same setting as before." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3073, - "kind": 32768, - "kindString": "Parameter", - "name": "restart_on_error", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3074, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run", - "type": "reference", - "target": "958" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3075, - "module": "_resource_clients.run", - "name": "reboot", - "parsedDocstring": { - "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The Actor run data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 261 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The Actor run data." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n" - } - ] - }, - "flags": {}, - "id": 3076, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "reboot", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3077, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run", - "type": "reference", - "target": "958" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3078, - "module": "_resource_clients.run", - "name": "dataset", - "parsedDocstring": { - "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n", - "returns": "A client allowing access to the default dataset of this Actor run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 280 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A client allowing access to the default dataset of this Actor run." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" - } - ] - }, - "flags": {}, - "id": 3079, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "dataset", - "parameters": [], - "type": { - "name": "DatasetClient", - "type": "reference", - "target": "2819" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3080, - "module": "_resource_clients.run", - "name": "key_value_store", - "parsedDocstring": { - "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n", - "returns": "A client allowing access to the default key-value store of this Actor run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 293 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A client allowing access to the default key-value store of this Actor run." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" - } - ] - }, - "flags": {}, - "id": 3081, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "key_value_store", - "parameters": [], - "type": { - "name": "KeyValueStoreClient", - "type": "reference", - "target": "3608" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3082, - "module": "_resource_clients.run", - "name": "request_queue", - "parsedDocstring": { - "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n", - "returns": "A client allowing access to the default request_queue of this Actor run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 306 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A client allowing access to the default request_queue of this Actor run." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" - } - ] - }, - "flags": {}, - "id": 3083, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "request_queue", - "parameters": [], - "type": { - "name": "RequestQueueClient", - "type": "reference", - "target": "1996" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3084, - "module": "_resource_clients.run", - "name": "log", - "parsedDocstring": { - "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n", - "returns": "A client allowing access to the log of this Actor run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 319 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A client allowing access to the log of this Actor run." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" - } - ] - }, - "flags": {}, - "id": 3085, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "log", - "parameters": [], - "type": { - "name": "LogClient", - "type": "reference", - "target": "2160" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n`StreamedLog` can be explicitly started and stopped or used as a context manager.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3086, - "module": "_resource_clients.run", - "name": "get_streamed_log", - "parsedDocstring": { - "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n`StreamedLog` can be explicitly started and stopped or used as a context manager.\n", - "args": { - "to_logger": "`Logger` used for logging the redirected messages. If not provided, a new logger is created", - "from_start": "If `True`, all logs from the start of the Actor run will be redirected. If `False`, only newly\narrived logs will be redirected. This can be useful for redirecting only a small portion of relevant\nlogs for long-running Actors in stand-by.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "`StreamedLog` instance for redirected logs." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 332 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "`StreamedLog` instance for redirected logs." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n`StreamedLog` can be explicitly started and stopped or used as a context manager.\n" - } - ] - }, - "flags": {}, - "id": 3087, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_streamed_log", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "`Logger` used for logging the redirected messages. If not provided, a new logger is created" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 3088, - "kind": 32768, - "kindString": "Parameter", - "name": "to_logger", - "type": { - "name": "logging.Logger | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "logging.Logger" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If `True`, all logs from the start of the Actor run will be redirected. If `False`, only newly\narrived logs will be redirected. This can be useful for redirecting only a small portion of relevant\nlogs for long-running Actors in stand-by." - } - ] - }, - "defaultValue": "True", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3089, - "kind": 32768, - "kindString": "Parameter", - "name": "from_start", - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3090, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "StreamedLog", - "type": "reference", - "target": "44" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3091, - "module": "_resource_clients.run", - "name": "charge", - "parsedDocstring": { - "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n", - "args": { - "event_name": "The name of the event to charge for.", - "count": "The number of events to charge.", - "idempotency_key": "A unique key to ensure idempotent charging. If not provided,\none will be auto-generated.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 375 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n" - } - ] - }, - "flags": {}, - "id": 3092, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "charge", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the event to charge for." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3093, - "kind": 32768, - "kindString": "Parameter", - "name": "event_name", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of events to charge." - } - ] - }, - "defaultValue": "1", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3094, - "kind": 32768, - "kindString": "Parameter", - "name": "count", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique key to ensure idempotent charging. If not provided,\none will be auto-generated." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3095, - "kind": 32768, - "kindString": "Parameter", - "name": "idempotency_key", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3096, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3097, - "module": "_resource_clients.run", - "name": "get_status_message_watcher", - "parsedDocstring": { - "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n", - "args": { - "to_logger": "`Logger` used for logging the status and status messages. If not provided, a new logger is\ncreated.", - "check_period": "The period with which the status message will be polled.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "`StatusMessageWatcher` instance." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 421 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "`StatusMessageWatcher` instance." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n" - } - ] - }, - "flags": {}, - "id": 3098, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_status_message_watcher", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "`Logger` used for logging the status and status messages. If not provided, a new logger is\ncreated." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3099, - "kind": 32768, - "kindString": "Parameter", - "name": "to_logger", - "type": { - "name": "logging.Logger | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "logging.Logger" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The period with which the status message will be polled." - } - ] - }, - "defaultValue": "timedelta(seconds=1)", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3100, - "kind": 32768, - "kindString": "Parameter", - "name": "check_period", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3101, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "StatusMessageWatcher", - "type": "reference", - "target": "1693" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 4007, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific Actor run.\n\nProvides methods to manage a specific Actor run, e.g. get it, update it, abort it, or wait for it to finish.\nObtain an instance via an appropriate method on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3034, - 3051, - 3091, - 3078, - 3048, - 3039, - 3097, - 3086, - 3080, - 3084, - 3059, - 3075, - 3082, - 3066, - 3042, - 3055 - ], - "title": "Methods" - }, - { - "children": [ - 4007 - ], - "title": "Properties" - } - ], - "id": 3033, - "module": "_resource_clients.run", - "name": "RunClient", - "parsedDocstring": { - "text": "Sub-client for managing a specific Actor run.\n\nProvides methods to manage a specific Actor run, e.g. get it, update it, abort it, or wait for it to finish.\nObtain an instance via an appropriate method on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 37 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3103, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 472 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3108, - "module": "_resource_clients.run", - "name": "get", - "parsedDocstring": { - "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved Actor run data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 485 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved Actor run data." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n" - } - ] - }, - "flags": {}, - "id": 3109, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3110, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Run", - "target": "958" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3111, - "module": "_resource_clients.run", - "name": "update", - "parsedDocstring": { - "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n", - "args": { - "status_message": "The new status message for the run.", - "is_status_message_terminal": "Set this flag to True if this is the final status message of the Actor run.", - "general_access": "Determines how others can access the run and its storages.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 501 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated run." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n" - } - ] - }, - "flags": {}, - "id": 3112, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new status message for the run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3113, - "kind": 32768, - "kindString": "Parameter", - "name": "status_message", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set this flag to True if this is the final status message of the Actor run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3114, - "kind": 32768, - "kindString": "Parameter", - "name": "is_status_message_terminal", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines how others can access the run and its storages." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3115, - "kind": 32768, - "kindString": "Parameter", - "name": "general_access", - "type": { - "name": "GeneralAccess | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "GeneralAccess", - "target": "1797" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3116, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run", - "type": "reference", - "target": "958" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3117, - "module": "_resource_clients.run", - "name": "abort", - "parsedDocstring": { - "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n", - "args": { - "gracefully": "If True, the Actor run will abort gracefully. It will send `aborting` and `persistStates`\nevents into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\nto resurrect the run later.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The data of the aborted Actor run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 530 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The data of the aborted Actor run." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n" - } - ] - }, - "flags": {}, - "id": 3118, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "abort", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, the Actor run will abort gracefully. It will send `aborting` and `persistStates`\nevents into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\nto resurrect the run later." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3119, - "kind": 32768, - "kindString": "Parameter", - "name": "gracefully", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3120, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run", - "type": "reference", - "target": "958" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wait asynchronously until the run finishes or the server times out.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3121, - "module": "_resource_clients.run", - "name": "wait_for_finish", - "parsedDocstring": { - "text": "Wait asynchronously until the run finishes or the server times out.\n", - "args": { - "wait_duration": "How long does the client wait for run to finish. None for indefinite.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The Actor run data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the run has not yet finished." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 553 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The Actor run data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the run has not yet finished." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Wait asynchronously until the run finishes or the server times out.\n" - } - ] - }, - "flags": {}, - "id": 3122, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "wait_for_finish", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How long does the client wait for run to finish. None for indefinite." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3123, - "kind": 32768, - "kindString": "Parameter", - "name": "wait_duration", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'no_timeout'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3124, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Run", - "target": "958" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3125, - "module": "_resource_clients.run", - "name": "delete", - "parsedDocstring": { - "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 577 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run\n" - } - ] - }, - "flags": {}, - "id": 3126, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3127, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3128, - "module": "_resource_clients.run", - "name": "metamorph", - "parsedDocstring": { - "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n", - "args": { - "target_actor_id": "ID of the target Actor that the run should be transformed into.", - "target_actor_build": "The build of the target Actor. It can be either a build tag or build number.\nBy default, the run uses the build specified in the default run configuration for the target Actor\n(typically the latest build).", - "run_input": "The input to pass to the new run.", - "content_type": "The content type of the input.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The Actor run data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 587 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The Actor run data." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n" - } - ] - }, - "flags": {}, - "id": 3129, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "metamorph", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the target Actor that the run should be transformed into." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3130, - "kind": 32768, - "kindString": "Parameter", - "name": "target_actor_id", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The build of the target Actor. It can be either a build tag or build number.\nBy default, the run uses the build specified in the default run configuration for the target Actor\n(typically the latest build)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3131, - "kind": 32768, - "kindString": "Parameter", - "name": "target_actor_build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The input to pass to the new run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3132, - "kind": 32768, - "kindString": "Parameter", - "name": "run_input", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type of the input." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3133, - "kind": 32768, - "kindString": "Parameter", - "name": "content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3134, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run", - "type": "reference", - "target": "958" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3135, - "module": "_resource_clients.run", - "name": "resurrect", - "parsedDocstring": { - "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n", - "args": { - "build": "Which Actor build the resurrected run should use. It can be either a build tag or build number.\nBy default, the resurrected run uses the same build as before.", - "memory_mbytes": "New memory limit for the resurrected run, in megabytes. By default, the resurrected run\nuses the same memory limit as before.", - "run_timeout": "New timeout for the resurrected run. By default, the resurrected run uses the\nsame timeout as before.", - "max_items": "Maximum number of items that the resurrected pay-per-result run will return. By default, the\nresurrected run uses the same limit as before. Limit can be only increased.", - "max_total_charge_usd": "Maximum cost for the resurrected pay-per-event run in USD. By default, the\nresurrected run uses the same limit as before. Limit can be only increased.", - "restart_on_error": "Determines whether the resurrected run will be restarted if it fails.\nBy default, the resurrected run uses the same setting as before.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The Actor run data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 633 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The Actor run data." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n" - } - ] - }, - "flags": {}, - "id": 3136, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "resurrect", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Which Actor build the resurrected run should use. It can be either a build tag or build number.\nBy default, the resurrected run uses the same build as before." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3137, - "kind": 32768, - "kindString": "Parameter", - "name": "build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "New memory limit for the resurrected run, in megabytes. By default, the resurrected run\nuses the same memory limit as before." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3138, - "kind": 32768, - "kindString": "Parameter", - "name": "memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "New timeout for the resurrected run. By default, the resurrected run uses the\nsame timeout as before." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3139, - "kind": 32768, - "kindString": "Parameter", - "name": "run_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items that the resurrected pay-per-result run will return. By default, the\nresurrected run uses the same limit as before. Limit can be only increased." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3140, - "kind": 32768, - "kindString": "Parameter", - "name": "max_items", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum cost for the resurrected pay-per-event run in USD. By default, the\nresurrected run uses the same limit as before. Limit can be only increased." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3141, - "kind": 32768, - "kindString": "Parameter", - "name": "max_total_charge_usd", - "type": { - "name": "Decimal | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Decimal" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines whether the resurrected run will be restarted if it fails.\nBy default, the resurrected run uses the same setting as before." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3142, - "kind": 32768, - "kindString": "Parameter", - "name": "restart_on_error", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3143, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run", - "type": "reference", - "target": "958" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3144, - "module": "_resource_clients.run", - "name": "reboot", - "parsedDocstring": { - "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The Actor run data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 688 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The Actor run data." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n" - } - ] - }, - "flags": {}, - "id": 3145, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "reboot", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3146, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run", - "type": "reference", - "target": "958" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3147, - "module": "_resource_clients.run", - "name": "dataset", - "parsedDocstring": { - "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n", - "returns": "A client allowing access to the default dataset of this Actor run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 707 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A client allowing access to the default dataset of this Actor run." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" - } - ] - }, - "flags": {}, - "id": 3148, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "dataset", - "parameters": [], - "type": { - "name": "DatasetClientAsync", - "type": "reference", - "target": "2926" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3149, - "module": "_resource_clients.run", - "name": "key_value_store", - "parsedDocstring": { - "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n", - "returns": "A client allowing access to the default key-value store of this Actor run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 720 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A client allowing access to the default key-value store of this Actor run." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" - } - ] - }, - "flags": {}, - "id": 3150, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "key_value_store", - "parameters": [], - "type": { - "name": "KeyValueStoreClientAsync", - "type": "reference", - "target": "3683" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3151, - "module": "_resource_clients.run", - "name": "request_queue", - "parsedDocstring": { - "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n", - "returns": "A client allowing access to the default request_queue of this Actor run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 733 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A client allowing access to the default request_queue of this Actor run." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" - } - ] - }, - "flags": {}, - "id": 3152, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "request_queue", - "parameters": [], - "type": { - "name": "RequestQueueClientAsync", - "type": "reference", - "target": "2078" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3153, - "module": "_resource_clients.run", - "name": "log", - "parsedDocstring": { - "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n", - "returns": "A client allowing access to the log of this Actor run." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 746 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A client allowing access to the log of this Actor run." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" - } - ] - }, - "flags": {}, - "id": 3154, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "log", - "parameters": [], - "type": { - "name": "LogClientAsync", - "type": "reference", - "target": "2177" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n`StreamedLog` can be explicitly started and stopped or used as a context manager.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3155, - "module": "_resource_clients.run", - "name": "get_streamed_log", - "parsedDocstring": { - "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n`StreamedLog` can be explicitly started and stopped or used as a context manager.\n", - "args": { - "to_logger": "`Logger` used for logging the redirected messages. If not provided, a new logger is created", - "from_start": "If `True`, all logs from the start of the Actor run will be redirected. If `False`, only newly\narrived logs will be redirected. This can be useful for redirecting only a small portion of relevant\nlogs for long-running Actors in stand-by.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "`StreamedLog` instance for redirected logs." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 759 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "`StreamedLog` instance for redirected logs." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n`StreamedLog` can be explicitly started and stopped or used as a context manager.\n" - } - ] - }, - "flags": {}, - "id": 3156, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_streamed_log", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "`Logger` used for logging the redirected messages. If not provided, a new logger is created" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 3157, - "kind": 32768, - "kindString": "Parameter", - "name": "to_logger", - "type": { - "name": "logging.Logger | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "logging.Logger" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If `True`, all logs from the start of the Actor run will be redirected. If `False`, only newly\narrived logs will be redirected. This can be useful for redirecting only a small portion of relevant\nlogs for long-running Actors in stand-by." - } - ] - }, - "defaultValue": "True", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3158, - "kind": 32768, - "kindString": "Parameter", - "name": "from_start", - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3159, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "StreamedLogAsync", - "type": "reference", - "target": "61" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3160, - "module": "_resource_clients.run", - "name": "charge", - "parsedDocstring": { - "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n", - "args": { - "event_name": "The name of the event to charge for.", - "count": "The number of events to charge.", - "idempotency_key": "A unique key to ensure idempotent charging. If not provided,\none will be auto-generated.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 802 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n" - } - ] - }, - "flags": {}, - "id": 3161, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "charge", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the event to charge for." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3162, - "kind": 32768, - "kindString": "Parameter", - "name": "event_name", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of events to charge." - } - ] - }, - "defaultValue": "1", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3163, - "kind": 32768, - "kindString": "Parameter", - "name": "count", - "type": { - "name": "int", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique key to ensure idempotent charging. If not provided,\none will be auto-generated." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3164, - "kind": 32768, - "kindString": "Parameter", - "name": "idempotency_key", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3165, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3166, - "module": "_resource_clients.run", - "name": "get_status_message_watcher", - "parsedDocstring": { - "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n", - "args": { - "to_logger": "`Logger` used for logging the status and status messages. If not provided, a new logger is\ncreated.", - "check_period": "The period with which the status message will be polled.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "`StatusMessageWatcher` instance." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 848 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "`StatusMessageWatcher` instance." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n" - } - ] - }, - "flags": {}, - "id": 3167, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_status_message_watcher", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "`Logger` used for logging the status and status messages. If not provided, a new logger is\ncreated." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3168, - "kind": 32768, - "kindString": "Parameter", - "name": "to_logger", - "type": { - "name": "logging.Logger | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "logging.Logger" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The period with which the status message will be polled." - } - ] - }, - "defaultValue": "timedelta(seconds=1)", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3169, - "kind": 32768, - "kindString": "Parameter", - "name": "check_period", - "type": { - "name": "timedelta", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3170, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "StatusMessageWatcherAsync", - "type": "reference", - "target": "1676" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3980, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific Actor run.\n\nProvides methods to manage a specific Actor run, e.g. get it, update it, abort it, or wait for it to finish.\nObtain an instance via an appropriate method on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3103, - 3117, - 3160, - 3147, - 3125, - 3108, - 3166, - 3155, - 3149, - 3153, - 3128, - 3144, - 3151, - 3135, - 3111, - 3121 - ], - "title": "Methods" - }, - { - "children": [ - 3980 - ], - "title": "Properties" - } - ], - "id": 3102, - "module": "_resource_clients.run", - "name": "RunClientAsync", - "parsedDocstring": { - "text": "Sub-client for managing a specific Actor run.\n\nProvides methods to manage a specific Actor run, e.g. get it, update it, abort it, or wait for it to finish.\nObtain an instance via an appropriate method on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 465 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3172, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 25 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3177, - "module": "_resource_clients.build", - "name": "get", - "parsedDocstring": { - "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved Actor build data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 38 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved Actor build data." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n" - } - ] - }, - "flags": {}, - "id": 3178, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3179, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Build | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Build", - "target": "306" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3180, - "module": "_resource_clients.build", - "name": "delete", - "parsedDocstring": { - "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 54 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build\n" - } - ] - }, - "flags": {}, - "id": 3181, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3182, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3183, - "module": "_resource_clients.build", - "name": "abort", - "parsedDocstring": { - "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The data of the aborted Actor build." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 64 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The data of the aborted Actor build." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n" - } - ] - }, - "flags": {}, - "id": 3184, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "abort", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3185, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Build", - "type": "reference", - "target": "306" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3186, - "module": "_resource_clients.build", - "name": "get_open_api_definition", - "parsedDocstring": { - "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "OpenAPI definition of the Actor's build." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 84 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "OpenAPI definition of the Actor's build." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n" - } - ] - }, - "flags": {}, - "id": 3187, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_open_api_definition", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3188, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "dict", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wait synchronously until the build finishes or the server times out.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3189, - "module": "_resource_clients.build", - "name": "wait_for_finish", - "parsedDocstring": { - "text": "Wait synchronously until the build finishes or the server times out.\n", - "args": { - "wait_duration": "How long does the client wait for build to finish. None for indefinite.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The Actor build data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the build has not yet finished." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 102 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The Actor build data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the build has not yet finished." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Wait synchronously until the build finishes or the server times out.\n" - } - ] - }, - "flags": {}, - "id": 3190, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "wait_for_finish", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How long does the client wait for build to finish. None for indefinite." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3191, - "kind": 32768, - "kindString": "Parameter", - "name": "wait_duration", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'no_timeout'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3192, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Build | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Build", - "target": "306" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3193, - "module": "_resource_clients.build", - "name": "log", - "parsedDocstring": { - "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n", - "returns": "A client allowing access to the log of this Actor build." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 123 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A client allowing access to the log of this Actor build." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n" - } - ] - }, - "flags": {}, - "id": 3194, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "log", - "parameters": [], - "type": { - "name": "LogClient", - "type": "reference", - "target": "2160" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 4008, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific Actor build.\n\nProvides methods to manage a specific Actor build, e.g. get it, abort it, or wait for it to finish. Obtain an\ninstance via an appropriate method on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3172, - 3183, - 3180, - 3177, - 3186, - 3193, - 3189 - ], - "title": "Methods" - }, - { - "children": [ - 4008 - ], - "title": "Properties" - } - ], - "id": 3171, - "module": "_resource_clients.build", - "name": "BuildClient", - "parsedDocstring": { - "text": "Sub-client for managing a specific Actor build.\n\nProvides methods to manage a specific Actor build, e.g. get it, abort it, or wait for it to finish. Obtain an\ninstance via an appropriate method on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 18 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3196, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 145 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3201, - "module": "_resource_clients.build", - "name": "get", - "parsedDocstring": { - "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved Actor build data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 158 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved Actor build data." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n" - } - ] - }, - "flags": {}, - "id": 3202, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3203, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Build | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Build", - "target": "306" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3204, - "module": "_resource_clients.build", - "name": "abort", - "parsedDocstring": { - "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The data of the aborted Actor build." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 174 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The data of the aborted Actor build." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n" - } - ] - }, - "flags": {}, - "id": 3205, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "abort", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3206, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Build", - "type": "reference", - "target": "306" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3207, - "module": "_resource_clients.build", - "name": "delete", - "parsedDocstring": { - "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 194 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build\n" - } - ] - }, - "flags": {}, - "id": 3208, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3209, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3210, - "module": "_resource_clients.build", - "name": "get_open_api_definition", - "parsedDocstring": { - "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "OpenAPI definition of the Actor's build." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 204 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "OpenAPI definition of the Actor's build." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n" - } - ] - }, - "flags": {}, - "id": 3211, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_open_api_definition", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3212, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "dict", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wait asynchronously until the build finishes or the server times out.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3213, - "module": "_resource_clients.build", - "name": "wait_for_finish", - "parsedDocstring": { - "text": "Wait asynchronously until the build finishes or the server times out.\n", - "args": { - "wait_duration": "How long does the client wait for build to finish. None for indefinite.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The Actor build data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the build has not yet finished." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 222 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The Actor build data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the build has not yet finished." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Wait asynchronously until the build finishes or the server times out.\n" - } - ] - }, - "flags": {}, - "id": 3214, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "wait_for_finish", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How long does the client wait for build to finish. None for indefinite." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3215, - "kind": 32768, - "kindString": "Parameter", - "name": "wait_duration", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'no_timeout'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3216, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Build | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Build", - "target": "306" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3217, - "module": "_resource_clients.build", - "name": "log", - "parsedDocstring": { - "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n", - "returns": "A client allowing access to the log of this Actor build." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 243 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A client allowing access to the log of this Actor build." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n" - } - ] - }, - "flags": {}, - "id": 3218, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "log", - "parameters": [], - "type": { - "name": "LogClientAsync", - "type": "reference", - "target": "2177" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3981, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific Actor build.\n\nProvides methods to manage a specific Actor build, e.g. get it, abort it, or wait for it to finish. Obtain an\ninstance via an appropriate method on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3196, - 3204, - 3207, - 3201, - 3210, - 3217, - 3213 - ], - "title": "Methods" - }, - { - "children": [ - 3981 - ], - "title": "Properties" - } - ], - "id": 3195, - "module": "_resource_clients.build", - "name": "BuildClientAsync", - "parsedDocstring": { - "text": "Sub-client for managing a specific Actor build.\n\nProvides methods to manage a specific Actor build, e.g. get it, abort it, or wait for it to finish. Obtain an\ninstance via an appropriate method on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/build.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 138 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3220, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 31 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3224, - "module": "_resource_clients.schedule_collection", - "name": "list", - "parsedDocstring": { - "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n", - "args": { - "limit": "How many schedules to retrieve.", - "offset": "What schedules to include as first when retrieving the list.", - "desc": "Whether to sort the schedules in descending order based on their modification date.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available schedules matching the specified filters." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 42 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available schedules matching the specified filters." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n" - } - ] - }, - "flags": {}, - "id": 3225, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many schedules to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3226, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What schedules to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3227, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the schedules in descending order based on their modification date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3228, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3229, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfSchedules", - "type": "reference", - "target": "771" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available schedules.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3230, - "module": "_resource_clients.schedule_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over the available schedules.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n", - "args": { - "limit": "How many schedules to retrieve.", - "offset": "What schedules to include as first when retrieving the list.", - "desc": "Whether to sort the schedules in descending order based on their modification date.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 66 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available schedules.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n" - } - ] - }, - "flags": {}, - "id": 3231, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many schedules to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3232, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What schedules to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3233, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the schedules in descending order based on their modification date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3234, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3235, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ScheduleShort", - "target": "1152" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3236, - "module": "_resource_clients.schedule_collection", - "name": "create", - "parsedDocstring": { - "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n", - "args": { - "cron_expression": "The cron expression used by this schedule.", - "is_enabled": "True if the schedule should be enabled.", - "is_exclusive": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule.", - "name": "The name of the schedule to create.", - "actions": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure.", - "description": "Description of this schedule.", - "timezone": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones).", - "title": "Title of this schedule.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The created schedule." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 96 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The created schedule." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n" - } - ] - }, - "flags": {}, - "id": 3237, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "create", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The cron expression used by this schedule." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3238, - "kind": 32768, - "kindString": "Parameter", - "name": "cron_expression", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "True if the schedule should be enabled." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3239, - "kind": 32768, - "kindString": "Parameter", - "name": "is_enabled", - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3240, - "kind": 32768, - "kindString": "Parameter", - "name": "is_exclusive", - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the schedule to create." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3241, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3242, - "kind": 32768, - "kindString": "Parameter", - "name": "actions", - "type": { - "name": "list[dict[str, Any]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Description of this schedule." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3243, - "kind": 32768, - "kindString": "Parameter", - "name": "description", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3244, - "kind": 32768, - "kindString": "Parameter", - "name": "timezone", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Title of this schedule." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3245, - "kind": 32768, - "kindString": "Parameter", - "name": "title", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3246, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Schedule", - "type": "reference", - "target": "1115" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 4009, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the schedule collection.\n\nProvides methods to manage the schedule collection, e.g. list or create schedules. Obtain an instance via an\nappropriate method on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3220, - 3236, - 3230, - 3224 - ], - "title": "Methods" - }, - { - "children": [ - 4009 - ], - "title": "Properties" - } - ], - "id": 3219, - "module": "_resource_clients.schedule_collection", - "name": "ScheduleCollectionClient", - "parsedDocstring": { - "text": "Sub-client for the schedule collection.\n\nProvides methods to manage the schedule collection, e.g. list or create schedules. Obtain an instance via an\nappropriate method on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 24 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3248, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 154 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3252, - "module": "_resource_clients.schedule_collection", - "name": "list", - "parsedDocstring": { - "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n", - "args": { - "limit": "How many schedules to retrieve.", - "offset": "What schedules to include as first when retrieving the list.", - "desc": "Whether to sort the schedules in descending order based on their modification date.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available schedules matching the specified filters." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 165 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available schedules matching the specified filters." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n" - } - ] - }, - "flags": {}, - "id": 3253, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many schedules to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3254, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What schedules to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3255, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the schedules in descending order based on their modification date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3256, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3257, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfSchedules", - "type": "reference", - "target": "771" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available schedules.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3258, - "module": "_resource_clients.schedule_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over the available schedules.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n", - "args": { - "limit": "How many schedules to retrieve.", - "offset": "What schedules to include as first when retrieving the list.", - "desc": "Whether to sort the schedules in descending order based on their modification date.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 189 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available schedules.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n" - } - ] - }, - "flags": {}, - "id": 3259, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many schedules to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3260, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What schedules to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3261, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the schedules in descending order based on their modification date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3262, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3263, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "ScheduleShort", - "target": "1152" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3264, - "module": "_resource_clients.schedule_collection", - "name": "create", - "parsedDocstring": { - "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n", - "args": { - "cron_expression": "The cron expression used by this schedule.", - "is_enabled": "True if the schedule should be enabled.", - "is_exclusive": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule.", - "name": "The name of the schedule to create.", - "actions": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure.", - "description": "Description of this schedule.", - "timezone": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones).", - "title": "Title of this schedule.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The created schedule." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 219 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The created schedule." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n" - } - ] - }, - "flags": {}, - "id": 3265, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "create", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The cron expression used by this schedule." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3266, - "kind": 32768, - "kindString": "Parameter", - "name": "cron_expression", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "True if the schedule should be enabled." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3267, - "kind": 32768, - "kindString": "Parameter", - "name": "is_enabled", - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3268, - "kind": 32768, - "kindString": "Parameter", - "name": "is_exclusive", - "type": { - "name": "bool", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the schedule to create." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3269, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3270, - "kind": 32768, - "kindString": "Parameter", - "name": "actions", - "type": { - "name": "list[dict[str, Any]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Description of this schedule." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3271, - "kind": 32768, - "kindString": "Parameter", - "name": "description", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3272, - "kind": 32768, - "kindString": "Parameter", - "name": "timezone", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Title of this schedule." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3273, - "kind": 32768, - "kindString": "Parameter", - "name": "title", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3274, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Schedule", - "type": "reference", - "target": "1115" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3982, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the schedule collection.\n\nProvides methods to manage the schedule collection, e.g. list or create schedules. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3248, - 3264, - 3258, - 3252 - ], - "title": "Methods" - }, - { - "children": [ - 3982 - ], - "title": "Properties" - } - ], - "id": 3247, - "module": "_resource_clients.schedule_collection", - "name": "ScheduleCollectionClientAsync", - "parsedDocstring": { - "text": "Sub-client for the schedule collection.\n\nProvides methods to manage the schedule collection, e.g. list or create schedules. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 147 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3276, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 38 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3280, - "module": "_resource_clients.actor_version_collection", - "name": "list", - "parsedDocstring": { - "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available Actor versions." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 49 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available Actor versions." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n" - } - ] - }, - "flags": {}, - "id": 3281, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3282, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfVersions", - "type": "reference", - "target": "700" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available Actor versions.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more\nversions than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3283, - "module": "_resource_clients.actor_version_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over the available Actor versions.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more\nversions than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 63 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available Actor versions.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more\nversions than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n" - } - ] - }, - "flags": {}, - "id": 3284, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3285, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Version", - "target": "1336" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3286, - "module": "_resource_clients.actor_version_collection", - "name": "create", - "parsedDocstring": { - "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n", - "args": { - "version_number": "Major and minor version of the Actor (e.g. `1.0`).", - "build_tag": "Tag that is automatically set to the latest successful build of the current version.", - "env_vars": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure.", - "apply_env_vars_to_build": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process.", - "source_type": "What source type is the Actor version using.", - "source_files": "Source code comprised of multiple files, each an item of the array. Required\nwhen `source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure.", - "git_repo_url": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`.", - "tarball_url": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`.", - "github_gist_url": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The created Actor version." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 81 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The created Actor version." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n" - } - ] - }, - "flags": {}, - "id": 3287, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "create", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Major and minor version of the Actor (e.g. `1.0`)." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3288, - "kind": 32768, - "kindString": "Parameter", - "name": "version_number", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tag that is automatically set to the latest successful build of the current version." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3289, - "kind": 32768, - "kindString": "Parameter", - "name": "build_tag", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3290, - "kind": 32768, - "kindString": "Parameter", - "name": "env_vars", - "type": { - "name": "list[dict[str, Any]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3291, - "kind": 32768, - "kindString": "Parameter", - "name": "apply_env_vars_to_build", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What source type is the Actor version using." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3292, - "kind": 32768, - "kindString": "Parameter", - "name": "source_type", - "type": { - "name": "VersionSourceType", - "type": "reference", - "target": "1802" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Source code comprised of multiple files, each an item of the array. Required\nwhen `source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3293, - "kind": 32768, - "kindString": "Parameter", - "name": "source_files", - "type": { - "name": "list[dict[str, Any]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3294, - "kind": 32768, - "kindString": "Parameter", - "name": "git_repo_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3295, - "kind": 32768, - "kindString": "Parameter", - "name": "tarball_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3296, - "kind": 32768, - "kindString": "Parameter", - "name": "github_gist_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3297, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Version", - "type": "reference", - "target": "1336" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 4010, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the Actor version collection.\n\nProvides methods to manage Actor versions, e.g. list or create them. Obtain an instance via an appropriate method\non the `ActorClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3276, - 3286, - 3283, - 3280 - ], - "title": "Methods" - }, - { - "children": [ - 4010 - ], - "title": "Properties" - } - ], - "id": 3275, - "module": "_resource_clients.actor_version_collection", - "name": "ActorVersionCollectionClient", - "parsedDocstring": { - "text": "Sub-client for the Actor version collection.\n\nProvides methods to manage Actor versions, e.g. list or create them. Obtain an instance via an appropriate method\non the `ActorClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 31 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3299, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 143 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3303, - "module": "_resource_clients.actor_version_collection", - "name": "list", - "parsedDocstring": { - "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available Actor versions." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 154 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available Actor versions." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n" - } - ] - }, - "flags": {}, - "id": 3304, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3305, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfVersions", - "type": "reference", - "target": "700" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available Actor versions.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more\nversions than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3306, - "module": "_resource_clients.actor_version_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over the available Actor versions.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more\nversions than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 168 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available Actor versions.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more\nversions than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n" - } - ] - }, - "flags": {}, - "id": 3307, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3308, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "Version", - "target": "1336" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3309, - "module": "_resource_clients.actor_version_collection", - "name": "create", - "parsedDocstring": { - "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n", - "args": { - "version_number": "Major and minor version of the Actor (e.g. `1.0`).", - "build_tag": "Tag that is automatically set to the latest successful build of the current version.", - "env_vars": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure.", - "apply_env_vars_to_build": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process.", - "source_type": "What source type is the Actor version using.", - "source_files": "Source code comprised of multiple files, each an item of the array. Required\nwhen `source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure.", - "git_repo_url": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`.", - "tarball_url": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`.", - "github_gist_url": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The created Actor version." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 187 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The created Actor version." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n" - } - ] - }, - "flags": {}, - "id": 3310, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "create", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Major and minor version of the Actor (e.g. `1.0`)." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3311, - "kind": 32768, - "kindString": "Parameter", - "name": "version_number", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tag that is automatically set to the latest successful build of the current version." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3312, - "kind": 32768, - "kindString": "Parameter", - "name": "build_tag", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3313, - "kind": 32768, - "kindString": "Parameter", - "name": "env_vars", - "type": { - "name": "list[dict[str, Any]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3314, - "kind": 32768, - "kindString": "Parameter", - "name": "apply_env_vars_to_build", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What source type is the Actor version using." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3315, - "kind": 32768, - "kindString": "Parameter", - "name": "source_type", - "type": { - "name": "VersionSourceType", - "type": "reference", - "target": "1802" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Source code comprised of multiple files, each an item of the array. Required\nwhen `source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3316, - "kind": 32768, - "kindString": "Parameter", - "name": "source_files", - "type": { - "name": "list[dict[str, Any]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3317, - "kind": 32768, - "kindString": "Parameter", - "name": "git_repo_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3318, - "kind": 32768, - "kindString": "Parameter", - "name": "tarball_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3319, - "kind": 32768, - "kindString": "Parameter", - "name": "github_gist_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3320, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Version", - "type": "reference", - "target": "1336" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3983, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the Actor version collection.\n\nProvides methods to manage Actor versions, e.g. list or create them. Obtain an instance via an appropriate method\non the `ActorClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3299, - 3309, - 3306, - 3303 - ], - "title": "Methods" - }, - { - "children": [ - 3983 - ], - "title": "Properties" - } - ], - "id": 3298, - "module": "_resource_clients.actor_version_collection", - "name": "ActorVersionCollectionClientAsync", - "parsedDocstring": { - "text": "Sub-client for the Actor version collection.\n\nProvides methods to manage Actor versions, e.g. list or create them. Obtain an instance via an appropriate method\non the `ActorClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 136 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3322, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 31 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3326, - "module": "_resource_clients.dataset_collection", - "name": "list", - "parsedDocstring": { - "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n", - "args": { - "unnamed": "Whether to include unnamed datasets in the list.", - "limit": "How many datasets to retrieve.", - "offset": "What dataset to include as first when retrieving the list.", - "desc": "Whether to sort the datasets in descending order based on their modification date.", - "ownership": "Filter by ownership. `'ownedByMe'` returns only user's own datasets,\n`'sharedWithMe'` returns only datasets shared with the user.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available datasets matching the specified filters." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 42 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available datasets matching the specified filters." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n" - } - ] - }, - "flags": {}, - "id": 3327, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include unnamed datasets in the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3328, - "kind": 32768, - "kindString": "Parameter", - "name": "unnamed", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many datasets to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3329, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What dataset to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3330, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the datasets in descending order based on their modification date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3331, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by ownership. `'ownedByMe'` returns only user's own datasets,\n`'sharedWithMe'` returns only datasets shared with the user." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3332, - "kind": 32768, - "kindString": "Parameter", - "name": "ownership", - "type": { - "name": "StorageOwnership | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "StorageOwnership", - "target": "1801" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3333, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfDatasets", - "type": "reference", - "target": "759" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available datasets.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3334, - "module": "_resource_clients.dataset_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over the available datasets.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n", - "args": { - "unnamed": "Whether to include unnamed datasets in the list.", - "limit": "How many datasets to retrieve.", - "offset": "What dataset to include as first when retrieving the list.", - "desc": "Whether to sort the datasets in descending order based on their modification date.", - "ownership": "Filter by ownership. 'ownedByMe' returns only user's own datasets,\n'sharedWithMe' returns only datasets shared with the user.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 78 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available datasets.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n" - } - ] - }, - "flags": {}, - "id": 3335, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include unnamed datasets in the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3336, - "kind": 32768, - "kindString": "Parameter", - "name": "unnamed", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many datasets to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3337, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What dataset to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3338, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the datasets in descending order based on their modification date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3339, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by ownership. 'ownedByMe' returns only user's own datasets,\n'sharedWithMe' returns only datasets shared with the user." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3340, - "kind": 32768, - "kindString": "Parameter", - "name": "ownership", - "type": { - "name": "StorageOwnership | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "StorageOwnership", - "target": "1801" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3341, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "DatasetListItem", - "target": "457" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3342, - "module": "_resource_clients.dataset_collection", - "name": "get_or_create", - "parsedDocstring": { - "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n", - "args": { - "name": "The name of the dataset to retrieve or create.", - "schema": "The schema of the dataset.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved or newly-created dataset." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 115 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved or newly-created dataset." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n" - } - ] - }, - "flags": {}, - "id": 3343, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_or_create", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the dataset to retrieve or create." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3344, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The schema of the dataset." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3345, - "kind": 32768, - "kindString": "Parameter", - "name": "schema", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3346, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Dataset", - "type": "reference", - "target": "432" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 4011, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the dataset collection.\n\nProvides methods to manage the dataset collection, e.g. list or create datasets. Obtain an instance via an\nappropriate method on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3322, - 3342, - 3334, - 3326 - ], - "title": "Methods" - }, - { - "children": [ - 4011 - ], - "title": "Properties" - } - ], - "id": 3321, - "module": "_resource_clients.dataset_collection", - "name": "DatasetCollectionClient", - "parsedDocstring": { - "text": "Sub-client for the dataset collection.\n\nProvides methods to manage the dataset collection, e.g. list or create datasets. Obtain an instance via an\nappropriate method on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 24 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3348, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 146 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3352, - "module": "_resource_clients.dataset_collection", - "name": "list", - "parsedDocstring": { - "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n", - "args": { - "unnamed": "Whether to include unnamed datasets in the list.", - "limit": "How many datasets to retrieve.", - "offset": "What dataset to include as first when retrieving the list.", - "desc": "Whether to sort the datasets in descending order based on their modification date.", - "ownership": "Filter by ownership. `'ownedByMe'` returns only user's own datasets,\n`'sharedWithMe'` returns only datasets shared with the user.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available datasets matching the specified filters." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 157 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available datasets matching the specified filters." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n" - } - ] - }, - "flags": {}, - "id": 3353, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include unnamed datasets in the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3354, - "kind": 32768, - "kindString": "Parameter", - "name": "unnamed", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many datasets to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3355, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What dataset to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3356, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the datasets in descending order based on their modification date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3357, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by ownership. `'ownedByMe'` returns only user's own datasets,\n`'sharedWithMe'` returns only datasets shared with the user." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3358, - "kind": 32768, - "kindString": "Parameter", - "name": "ownership", - "type": { - "name": "StorageOwnership | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "StorageOwnership", - "target": "1801" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3359, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfDatasets", - "type": "reference", - "target": "759" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available datasets.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3360, - "module": "_resource_clients.dataset_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over the available datasets.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n", - "args": { - "unnamed": "Whether to include unnamed datasets in the list.", - "limit": "How many datasets to retrieve.", - "offset": "What dataset to include as first when retrieving the list.", - "desc": "Whether to sort the datasets in descending order based on their modification date.", - "ownership": "Filter by ownership. 'ownedByMe' returns only user's own datasets,\n'sharedWithMe' returns only datasets shared with the user.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 193 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available datasets.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n" - } - ] - }, - "flags": {}, - "id": 3361, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include unnamed datasets in the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3362, - "kind": 32768, - "kindString": "Parameter", - "name": "unnamed", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many datasets to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3363, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What dataset to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3364, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the datasets in descending order based on their modification date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3365, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by ownership. 'ownedByMe' returns only user's own datasets,\n'sharedWithMe' returns only datasets shared with the user." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3366, - "kind": 32768, - "kindString": "Parameter", - "name": "ownership", - "type": { - "name": "StorageOwnership | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "StorageOwnership", - "target": "1801" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3367, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "DatasetListItem", - "target": "457" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3368, - "module": "_resource_clients.dataset_collection", - "name": "get_or_create", - "parsedDocstring": { - "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n", - "args": { - "name": "The name of the dataset to retrieve or create.", - "schema": "The schema of the dataset.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved or newly-created dataset." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 230 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved or newly-created dataset." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n" - } - ] - }, - "flags": {}, - "id": 3369, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_or_create", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the dataset to retrieve or create." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3370, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The schema of the dataset." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3371, - "kind": 32768, - "kindString": "Parameter", - "name": "schema", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3372, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Dataset", - "type": "reference", - "target": "432" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3984, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the dataset collection.\n\nProvides methods to manage the dataset collection, e.g. list or create datasets. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3348, - 3368, - 3360, - 3352 - ], - "title": "Methods" - }, - { - "children": [ - 3984 - ], - "title": "Properties" - } - ], - "id": 3347, - "module": "_resource_clients.dataset_collection", - "name": "DatasetCollectionClientAsync", - "parsedDocstring": { - "text": "Sub-client for the dataset collection.\n\nProvides methods to manage the dataset collection, e.g. list or create datasets. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 139 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3374, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 38 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3375, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3376, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3377, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3378, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3379, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3380, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3381, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3382, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3383, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base class with shared implementation for sync and async resource clients.\n\nProvides URL building, parameter handling, and client creation utilities." - } - ] - }, - "flags": {}, - "groups": [ - { - "children": [ - 3374 - ], - "title": "Methods" - }, - { - "children": [ - 3383 - ], - "title": "Properties" - } - ], - "id": 3373, - "module": "_resource_clients._resource_client", - "name": "ResourceClientBase", - "parsedDocstring": { - "text": "Base class with shared implementation for sync and async resource clients.\n\nProvides URL building, parameter handling, and client creation utilities." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 32 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedBy": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - }, - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3385, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 174 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientBase.__init__", - "target": 3374, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3962, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base class for synchronous resource clients." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3385 - ], - "title": "Methods" - }, - { - "children": [ - 3962 - ], - "title": "Properties" - } - ], - "id": 3384, - "module": "_resource_clients._resource_client", - "name": "ResourceClient", - "parsedDocstring": { - "text": "Base class for synchronous resource clients." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 171 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientBase", - "target": "3373", - "type": "reference" - } - ], - "extendedBy": [ - { - "name": "ScheduleClient", - "target": "1904", - "type": "reference" - }, - { - "name": "UserClient", - "target": "1956", - "type": "reference" - }, - { - "name": "RequestQueueClient", - "target": "1996", - "type": "reference" - }, - { - "name": "LogClient", - "target": "2160", - "type": "reference" - }, - { - "name": "ActorEnvVarCollectionClient", - "target": "2194", - "type": "reference" - }, - { - "name": "WebhookDispatchCollectionClient", - "target": "2228", - "type": "reference" - }, - { - "name": "ActorCollectionClient", - "target": "2262", - "type": "reference" - }, - { - "name": "WebhookDispatchClient", - "target": "2354", - "type": "reference" - }, - { - "name": "KeyValueStoreCollectionClient", - "target": "2372", - "type": "reference" - }, - { - "name": "ActorVersionClient", - "target": "2424", - "type": "reference" - }, - { - "name": "RequestQueueCollectionClient", - "target": "2480", - "type": "reference" - }, - { - "name": "TaskCollectionClient", - "target": "2530", - "type": "reference" - }, - { - "name": "StoreCollectionClient", - "target": "2598", - "type": "reference" - }, - { - "name": "TaskClient", - "target": "2648", - "type": "reference" - }, - { - "name": "BuildCollectionClient", - "target": "2778", - "type": "reference" - }, - { - "name": "DatasetClient", - "target": "2819", - "type": "reference" - }, - { - "name": "RunClient", - "target": "3033", - "type": "reference" - }, - { - "name": "BuildClient", - "target": "3171", - "type": "reference" - }, - { - "name": "ScheduleCollectionClient", - "target": "3219", - "type": "reference" - }, - { - "name": "ActorVersionCollectionClient", - "target": "3275", - "type": "reference" - }, - { - "name": "DatasetCollectionClient", - "target": "3321", - "type": "reference" - }, - { - "name": "ActorClient", - "target": "3404", - "type": "reference" - }, - { - "name": "KeyValueStoreClient", - "target": "3608", - "type": "reference" - }, - { - "name": "ActorEnvVarClient", - "target": "3758", - "type": "reference" - }, - { - "name": "WebhookCollectionClient", - "target": "3794", - "type": "reference" - }, - { - "name": "WebhookClient", - "target": "3856", - "type": "reference" - }, - { - "name": "RunCollectionClient", - "target": "3916", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3395, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 366 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientBase.__init__", - "target": 3374, - "type": "reference" - } - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3963, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Base class for asynchronous resource clients." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3395 - ], - "title": "Methods" - }, - { - "children": [ - 3963 - ], - "title": "Properties" - } - ], - "id": 3394, - "module": "_resource_clients._resource_client", - "name": "ResourceClientAsync", - "parsedDocstring": { - "text": "Base class for asynchronous resource clients." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 363 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientBase", - "target": "3373", - "type": "reference" - } - ], - "extendedBy": [ - { - "name": "ScheduleClientAsync", - "target": "1930", - "type": "reference" - }, - { - "name": "UserClientAsync", - "target": "1976", - "type": "reference" - }, - { - "name": "RequestQueueClientAsync", - "target": "2078", - "type": "reference" - }, - { - "name": "LogClientAsync", - "target": "2177", - "type": "reference" - }, - { - "name": "ActorEnvVarCollectionClientAsync", - "target": "2211", - "type": "reference" - }, - { - "name": "WebhookDispatchCollectionClientAsync", - "target": "2245", - "type": "reference" - }, - { - "name": "ActorCollectionClientAsync", - "target": "2308", - "type": "reference" - }, - { - "name": "WebhookDispatchClientAsync", - "target": "2363", - "type": "reference" - }, - { - "name": "KeyValueStoreCollectionClientAsync", - "target": "2398", - "type": "reference" - }, - { - "name": "ActorVersionClientAsync", - "target": "2452", - "type": "reference" - }, - { - "name": "RequestQueueCollectionClientAsync", - "target": "2505", - "type": "reference" - }, - { - "name": "TaskCollectionClientAsync", - "target": "2564", - "type": "reference" - }, - { - "name": "StoreCollectionClientAsync", - "target": "2623", - "type": "reference" - }, - { - "name": "TaskClientAsync", - "target": "2713", - "type": "reference" - }, - { - "name": "BuildCollectionClientAsync", - "target": "2795", - "type": "reference" - }, - { - "name": "DatasetClientAsync", - "target": "2926", - "type": "reference" - }, - { - "name": "RunClientAsync", - "target": "3102", - "type": "reference" - }, - { - "name": "BuildClientAsync", - "target": "3195", - "type": "reference" - }, - { - "name": "ScheduleCollectionClientAsync", - "target": "3247", - "type": "reference" - }, - { - "name": "ActorVersionCollectionClientAsync", - "target": "3298", - "type": "reference" - }, - { - "name": "DatasetCollectionClientAsync", - "target": "3347", - "type": "reference" - }, - { - "name": "ActorClientAsync", - "target": "3506", - "type": "reference" - }, - { - "name": "KeyValueStoreClientAsync", - "target": "3683", - "type": "reference" - }, - { - "name": "ActorEnvVarClientAsync", - "target": "3776", - "type": "reference" - }, - { - "name": "WebhookCollectionClientAsync", - "target": "3825", - "type": "reference" - }, - { - "name": "WebhookClientAsync", - "target": "3886", - "type": "reference" - }, - { - "name": "RunCollectionClientAsync", - "target": "3939", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3405, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 74 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3410, - "module": "_resource_clients.actor", - "name": "get", - "parsedDocstring": { - "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 87 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved Actor." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n" - } - ] - }, - "flags": {}, - "id": 3411, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3412, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Actor | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Actor", - "target": "192" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3413, - "module": "_resource_clients.actor", - "name": "update", - "parsedDocstring": { - "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n", - "args": { - "name": "The name of the Actor.", - "title": "The title of the Actor (human-readable).", - "description": "The description for the Actor.", - "seo_title": "The title of the Actor optimized for search engines.", - "seo_description": "The description of the Actor optimized for search engines.", - "versions": "The list of Actor versions.", - "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.", - "is_public": "Whether the Actor is public.", - "is_deprecated": "Whether the Actor is deprecated.", - "categories": "The categories to which the Actor belongs to.", - "default_run_build": "Tag or number of the build that you want to run by default.", - "default_run_max_items": "Default limit of the number of results that will be returned\nby runs of this Actor, if the Actor is charged per result.", - "default_run_memory_mbytes": "Default amount of memory allocated for the runs of this Actor, in megabytes.", - "default_run_timeout": "Default timeout for the runs of this Actor.", - "example_run_input_body": "Input to be prefilled as default input to new users of this Actor.", - "example_run_input_content_type": "The content type of the example run input.", - "actor_standby_is_enabled": "Whether the Actor Standby is enabled.", - "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.", - "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.", - "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.", - "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.", - "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.", - "pricing_infos": "A list of objects that describes the pricing of the Actor.", - "actor_permission_level": "The permission level of the Actor on Apify platform.", - "tagged_builds": "A dictionary mapping build tag names to their settings. Use it to create, update,\nor remove build tags. To assign a tag, provide a dict with 'buildId' key. To remove a tag,\nset its value to None. Example: {'latest': {'buildId': 'abc'}, 'beta': None}.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 103 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated Actor." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n" - } - ] - }, - "flags": {}, - "id": 3414, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3415, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the Actor (human-readable)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3416, - "kind": 32768, - "kindString": "Parameter", - "name": "title", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description for the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3417, - "kind": 32768, - "kindString": "Parameter", - "name": "description", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the Actor optimized for search engines." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3418, - "kind": 32768, - "kindString": "Parameter", - "name": "seo_title", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description of the Actor optimized for search engines." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3419, - "kind": 32768, - "kindString": "Parameter", - "name": "seo_description", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of Actor versions." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3420, - "kind": 32768, - "kindString": "Parameter", - "name": "versions", - "type": { - "name": "list[dict[str, Any]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3421, - "kind": 32768, - "kindString": "Parameter", - "name": "restart_on_error", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Actor is public." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3422, - "kind": 32768, - "kindString": "Parameter", - "name": "is_public", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Actor is deprecated." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3423, - "kind": 32768, - "kindString": "Parameter", - "name": "is_deprecated", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The categories to which the Actor belongs to." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3424, - "kind": 32768, - "kindString": "Parameter", - "name": "categories", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tag or number of the build that you want to run by default." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3425, - "kind": 32768, - "kindString": "Parameter", - "name": "default_run_build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default limit of the number of results that will be returned\nby runs of this Actor, if the Actor is charged per result." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3426, - "kind": 32768, - "kindString": "Parameter", - "name": "default_run_max_items", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default amount of memory allocated for the runs of this Actor, in megabytes." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3427, - "kind": 32768, - "kindString": "Parameter", - "name": "default_run_memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for the runs of this Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3428, - "kind": 32768, - "kindString": "Parameter", - "name": "default_run_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Input to be prefilled as default input to new users of this Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3429, - "kind": 32768, - "kindString": "Parameter", - "name": "example_run_input_body", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type of the example run input." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3430, - "kind": 32768, - "kindString": "Parameter", - "name": "example_run_input_content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Actor Standby is enabled." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3431, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_is_enabled", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3432, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_desired_requests_per_actor_run", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3433, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_max_requests_per_actor_run", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the Actor run does not receive any requests for this time,\nit will be shut down." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3434, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_idle_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The build tag or number to run when the Actor is in Standby mode." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3435, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The memory in megabytes to use when the Actor is in Standby mode." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3436, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of objects that describes the pricing of the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3437, - "kind": 32768, - "kindString": "Parameter", - "name": "pricing_infos", - "type": { - "name": "list[dict[str, Any]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The permission level of the Actor on Apify platform." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3438, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_permission_level", - "type": { - "name": "ActorPermissionLevel | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorPermissionLevel", - "target": "1795" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A dictionary mapping build tag names to their settings. Use it to create, update,\nor remove build tags. To assign a tag, provide a dict with 'buildId' key. To remove a tag,\nset its value to None. Example: {'latest': {'buildId': 'abc'}, 'beta': None}." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3439, - "kind": 32768, - "kindString": "Parameter", - "name": "tagged_builds", - "type": { - "name": "dict[str, None | dict[str, str]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "str" - } - ] - } - ] - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3440, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Actor", - "type": "reference", - "target": "192" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3441, - "module": "_resource_clients.actor", - "name": "delete", - "parsedDocstring": { - "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 211 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor\n" - } - ] - }, - "flags": {}, - "id": 3442, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3443, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3444, - "module": "_resource_clients.actor", - "name": "start", - "parsedDocstring": { - "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n", - "args": { - "run_input": "The input to pass to the Actor run.", - "content_type": "The content type of the input.", - "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest).", - "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit.", - "max_total_charge_usd": "A limit on the total charged amount for pay-per-event Actors.", - "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.", - "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor.", - "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor.", - "force_permission_level": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings.", - "wait_for_finish": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60.", - "webhooks": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The run object." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 221 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The run object." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n" - } - ] - }, - "flags": {}, - "id": 3445, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "start", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The input to pass to the Actor run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3446, - "kind": 32768, - "kindString": "Parameter", - "name": "run_input", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type of the input." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3447, - "kind": 32768, - "kindString": "Parameter", - "name": "content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3448, - "kind": 32768, - "kindString": "Parameter", - "name": "build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3449, - "kind": 32768, - "kindString": "Parameter", - "name": "max_items", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A limit on the total charged amount for pay-per-event Actors." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3450, - "kind": 32768, - "kindString": "Parameter", - "name": "max_total_charge_usd", - "type": { - "name": "Decimal | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Decimal" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3451, - "kind": 32768, - "kindString": "Parameter", - "name": "restart_on_error", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3452, - "kind": 32768, - "kindString": "Parameter", - "name": "memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3453, - "kind": 32768, - "kindString": "Parameter", - "name": "run_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3454, - "kind": 32768, - "kindString": "Parameter", - "name": "force_permission_level", - "type": { - "name": "ActorPermissionLevel | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorPermissionLevel", - "target": "1795" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3455, - "kind": 32768, - "kindString": "Parameter", - "name": "wait_for_finish", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3456, - "kind": 32768, - "kindString": "Parameter", - "name": "webhooks", - "type": { - "name": "WebhooksList | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "WebhooksList", - "target": "14" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3457, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run", - "type": "reference", - "target": "958" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3458, - "module": "_resource_clients.actor", - "name": "call", - "parsedDocstring": { - "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n", - "args": { - "run_input": "The input to pass to the Actor run.", - "content_type": "The content type of the input.", - "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest).", - "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit.", - "max_total_charge_usd": "A limit on the total charged amount for pay-per-event Actors.", - "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.", - "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor.", - "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor.", - "force_permission_level": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings.", - "webhooks": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here.", - "wait_duration": "The maximum time the server waits for the run to finish. If not provided,\nwaits indefinitely.", - "logger": "Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\ndefault logger will be used. Setting `None` will disable any log propagation. Passing custom logger\nwill redirect logs to the provided logger. The logger is also used to capture status and status message\nof the other Actor run.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The run object." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 297 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The run object." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n" - } - ] - }, - "flags": {}, - "id": 3459, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "call", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The input to pass to the Actor run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3460, - "kind": 32768, - "kindString": "Parameter", - "name": "run_input", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type of the input." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3461, - "kind": 32768, - "kindString": "Parameter", - "name": "content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3462, - "kind": 32768, - "kindString": "Parameter", - "name": "build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3463, - "kind": 32768, - "kindString": "Parameter", - "name": "max_items", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A limit on the total charged amount for pay-per-event Actors." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3464, - "kind": 32768, - "kindString": "Parameter", - "name": "max_total_charge_usd", - "type": { - "name": "Decimal | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Decimal" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3465, - "kind": 32768, - "kindString": "Parameter", - "name": "restart_on_error", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3466, - "kind": 32768, - "kindString": "Parameter", - "name": "memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3467, - "kind": 32768, - "kindString": "Parameter", - "name": "run_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3468, - "kind": 32768, - "kindString": "Parameter", - "name": "webhooks", - "type": { - "name": "WebhooksList | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "WebhooksList", - "target": "14" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3469, - "kind": 32768, - "kindString": "Parameter", - "name": "force_permission_level", - "type": { - "name": "ActorPermissionLevel | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorPermissionLevel", - "target": "1795" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum time the server waits for the run to finish. If not provided,\nwaits indefinitely." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3470, - "kind": 32768, - "kindString": "Parameter", - "name": "wait_duration", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\ndefault logger will be used. Setting `None` will disable any log propagation. Passing custom logger\nwill redirect logs to the provided logger. The logger is also used to capture status and status message\nof the other Actor run." - } - ] - }, - "defaultValue": "'default'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3471, - "kind": 32768, - "kindString": "Parameter", - "name": "logger", - "type": { - "name": "Logger | None | Literal['default']", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "Logger" - }, - { - "type": "literal", - "value": null - } - ] - }, - { - "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "default" - } - ] - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'no_timeout'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3472, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Run", - "target": "958" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3473, - "module": "_resource_clients.actor", - "name": "build", - "parsedDocstring": { - "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n", - "args": { - "version_number": "Actor version number to be built.", - "beta_packages": "If True, then the Actor is built with beta versions of Apify NPM packages. By default,\nthe build uses latest stable packages.", - "tag": "Tag to be applied to the build on success. By default, the tag is taken from the Actor version's\nbuild tag property.", - "use_cache": "If true, the Actor's Docker container will be rebuilt using layer cache\n(https://docs.docker.com/develop/develop-images/dockerfile_best-practices/`leverage`-build-cache).\nThis is to enable quick rebuild during development. By default, the cache is not used.", - "wait_for_finish": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The build object." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 380 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The build object." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n" - } - ] - }, - "flags": {}, - "id": 3474, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "build", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Actor version number to be built." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3475, - "kind": 32768, - "kindString": "Parameter", - "name": "version_number", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then the Actor is built with beta versions of Apify NPM packages. By default,\nthe build uses latest stable packages." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3476, - "kind": 32768, - "kindString": "Parameter", - "name": "beta_packages", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tag to be applied to the build on success. By default, the tag is taken from the Actor version's\nbuild tag property." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3477, - "kind": 32768, - "kindString": "Parameter", - "name": "tag", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the Actor's Docker container will be rebuilt using layer cache\n(https://docs.docker.com/develop/develop-images/dockerfile_best-practices/`leverage`-build-cache).\nThis is to enable quick rebuild during development. By default, the cache is not used." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3478, - "kind": 32768, - "kindString": "Parameter", - "name": "use_cache", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3479, - "kind": 32768, - "kindString": "Parameter", - "name": "wait_for_finish", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3480, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Build", - "type": "reference", - "target": "306" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the builds of this Actor." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3481, - "module": "_resource_clients.actor", - "name": "builds", - "parsedDocstring": { - "text": "Retrieve a client for the builds of this Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 428 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the builds of this Actor." - } - ] - }, - "flags": {}, - "id": 3482, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "builds", - "parameters": [], - "type": { - "name": "BuildCollectionClient", - "type": "reference", - "target": "2778" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the runs of this Actor." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3483, - "module": "_resource_clients.actor", - "name": "runs", - "parsedDocstring": { - "text": "Retrieve a client for the runs of this Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 435 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the runs of this Actor." - } - ] - }, - "flags": {}, - "id": 3484, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "runs", - "parameters": [], - "type": { - "name": "RunCollectionClient", - "type": "reference", - "target": "3916" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3485, - "module": "_resource_clients.actor", - "name": "default_build", - "parsedDocstring": { - "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n", - "args": { - "wait_for_finish": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The resource client for the default build of this Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 442 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The resource client for the default build of this Actor." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n" - } - ] - }, - "flags": {}, - "id": 3486, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "default_build", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3487, - "kind": 32768, - "kindString": "Parameter", - "name": "wait_for_finish", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3488, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "BuildClient", - "type": "reference", - "target": "3171" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3489, - "module": "_resource_clients.actor", - "name": "last_run", - "parsedDocstring": { - "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n", - "args": { - "status": "Consider only runs with this status.", - "origin": "Consider only runs started with this origin.\n" - }, - "returns": "The resource client for the last run of this Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 480 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The resource client for the last run of this Actor." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n" - } - ] - }, - "flags": {}, - "id": 3490, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "last_run", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Consider only runs with this status." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3491, - "kind": 32768, - "kindString": "Parameter", - "name": "status", - "type": { - "name": "ActorJobStatus | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorJobStatus", - "target": "1794" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Consider only runs started with this origin.\n" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3492, - "kind": 32768, - "kindString": "Parameter", - "name": "origin", - "type": { - "name": "RunOrigin | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "RunOrigin", - "target": "1799" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "RunClient", - "type": "reference", - "target": "3033" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the versions of this Actor." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3493, - "module": "_resource_clients.actor", - "name": "versions", - "parsedDocstring": { - "text": "Retrieve a client for the versions of this Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 507 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the versions of this Actor." - } - ] - }, - "flags": {}, - "id": 3494, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "versions", - "parameters": [], - "type": { - "name": "ActorVersionCollectionClient", - "type": "reference", - "target": "3275" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the client for the specified version of this Actor.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3495, - "module": "_resource_clients.actor", - "name": "version", - "parsedDocstring": { - "text": "Retrieve the client for the specified version of this Actor.\n", - "args": { - "version_number": "The version number for which to retrieve the resource client.\n" - }, - "returns": "The resource client for the specified Actor version." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 511 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The resource client for the specified Actor version." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the client for the specified version of this Actor.\n" - } - ] - }, - "flags": {}, - "id": 3496, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "version", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The version number for which to retrieve the resource client.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3497, - "kind": 32768, - "kindString": "Parameter", - "name": "version_number", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "ActorVersionClient", - "type": "reference", - "target": "2424" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for webhooks associated with this Actor." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3498, - "module": "_resource_clients.actor", - "name": "webhooks", - "parsedDocstring": { - "text": "Retrieve a client for webhooks associated with this Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 525 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for webhooks associated with this Actor." - } - ] - }, - "flags": {}, - "id": 3499, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "webhooks", - "parameters": [], - "type": { - "name": "WebhookCollectionClient", - "type": "reference", - "target": "3794" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Validate an input for the Actor that defines an input schema.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3500, - "module": "_resource_clients.actor", - "name": "validate_input", - "parsedDocstring": { - "text": "Validate an input for the Actor that defines an input schema.\n", - "args": { - "run_input": "The input to validate.", - "build_tag": "The Actor's build tag.", - "content_type": "The content type of the input.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "True if the input is valid, else raise an exception with validation error details." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 529 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "True if the input is valid, else raise an exception with validation error details." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Validate an input for the Actor that defines an input schema.\n" - } - ] - }, - "flags": {}, - "id": 3501, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "validate_input", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The input to validate." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 3502, - "kind": 32768, - "kindString": "Parameter", - "name": "run_input", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Actor's build tag." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3503, - "kind": 32768, - "kindString": "Parameter", - "name": "build_tag", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type of the input." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3504, - "kind": 32768, - "kindString": "Parameter", - "name": "content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3505, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "bool", - "type": "reference" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 4012, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific Actor.\n\nProvides methods to manage a specific Actor, e.g. update it, delete it, build it, or start runs. Obtain an instance\nvia an appropriate method on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3405, - 3473, - 3481, - 3458, - 3485, - 3441, - 3410, - 3489, - 3483, - 3444, - 3413, - 3500, - 3495, - 3493, - 3498 - ], - "title": "Methods" - }, - { - "children": [ - 4012 - ], - "title": "Properties" - } - ], - "id": 3404, - "module": "_resource_clients.actor", - "name": "ActorClient", - "parsedDocstring": { - "text": "Sub-client for managing a specific Actor.\n\nProvides methods to manage a specific Actor, e.g. update it, delete it, build it, or start runs. Obtain an instance\nvia an appropriate method on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 67 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3507, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 570 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3512, - "module": "_resource_clients.actor", - "name": "get", - "parsedDocstring": { - "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 583 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved Actor." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n" - } - ] - }, - "flags": {}, - "id": 3513, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3514, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Actor | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Actor", - "target": "192" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3515, - "module": "_resource_clients.actor", - "name": "update", - "parsedDocstring": { - "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n", - "args": { - "name": "The name of the Actor.", - "title": "The title of the Actor (human-readable).", - "description": "The description for the Actor.", - "seo_title": "The title of the Actor optimized for search engines.", - "seo_description": "The description of the Actor optimized for search engines.", - "versions": "The list of Actor versions.", - "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.", - "is_public": "Whether the Actor is public.", - "is_deprecated": "Whether the Actor is deprecated.", - "categories": "The categories to which the Actor belongs to.", - "default_run_build": "Tag or number of the build that you want to run by default.", - "default_run_max_items": "Default limit of the number of results that will be returned\nby runs of this Actor, if the Actor is charged per result.", - "default_run_memory_mbytes": "Default amount of memory allocated for the runs of this Actor, in megabytes.", - "default_run_timeout": "Default timeout for the runs of this Actor.", - "example_run_input_body": "Input to be prefilled as default input to new users of this Actor.", - "example_run_input_content_type": "The content type of the example run input.", - "actor_standby_is_enabled": "Whether the Actor Standby is enabled.", - "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.", - "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.", - "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.", - "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.", - "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.", - "pricing_infos": "A list of objects that describes the pricing of the Actor.", - "actor_permission_level": "The permission level of the Actor on Apify platform.", - "tagged_builds": "A dictionary mapping build tag names to their settings. Use it to create, update,\nor remove build tags. To assign a tag, provide a dict with 'buildId' key. To remove a tag,\nset its value to None. Example: {'latest': {'buildId': 'abc'}, 'beta': None}.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 599 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated Actor." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n" - } - ] - }, - "flags": {}, - "id": 3516, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3517, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the Actor (human-readable)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3518, - "kind": 32768, - "kindString": "Parameter", - "name": "title", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description for the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3519, - "kind": 32768, - "kindString": "Parameter", - "name": "description", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the Actor optimized for search engines." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3520, - "kind": 32768, - "kindString": "Parameter", - "name": "seo_title", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description of the Actor optimized for search engines." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3521, - "kind": 32768, - "kindString": "Parameter", - "name": "seo_description", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of Actor versions." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3522, - "kind": 32768, - "kindString": "Parameter", - "name": "versions", - "type": { - "name": "list[dict[str, Any]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3523, - "kind": 32768, - "kindString": "Parameter", - "name": "restart_on_error", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Actor is public." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3524, - "kind": 32768, - "kindString": "Parameter", - "name": "is_public", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Actor is deprecated." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3525, - "kind": 32768, - "kindString": "Parameter", - "name": "is_deprecated", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The categories to which the Actor belongs to." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3526, - "kind": 32768, - "kindString": "Parameter", - "name": "categories", - "type": { - "name": "list[str] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "str" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tag or number of the build that you want to run by default." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3527, - "kind": 32768, - "kindString": "Parameter", - "name": "default_run_build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default limit of the number of results that will be returned\nby runs of this Actor, if the Actor is charged per result." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3528, - "kind": 32768, - "kindString": "Parameter", - "name": "default_run_max_items", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default amount of memory allocated for the runs of this Actor, in megabytes." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3529, - "kind": 32768, - "kindString": "Parameter", - "name": "default_run_memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default timeout for the runs of this Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3530, - "kind": 32768, - "kindString": "Parameter", - "name": "default_run_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Input to be prefilled as default input to new users of this Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3531, - "kind": 32768, - "kindString": "Parameter", - "name": "example_run_input_body", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type of the example run input." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3532, - "kind": 32768, - "kindString": "Parameter", - "name": "example_run_input_content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Actor Standby is enabled." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3533, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_is_enabled", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3534, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_desired_requests_per_actor_run", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3535, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_max_requests_per_actor_run", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the Actor run does not receive any requests for this time,\nit will be shut down." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3536, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_idle_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The build tag or number to run when the Actor is in Standby mode." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3537, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The memory in megabytes to use when the Actor is in Standby mode." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3538, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_standby_memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of objects that describes the pricing of the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3539, - "kind": 32768, - "kindString": "Parameter", - "name": "pricing_infos", - "type": { - "name": "list[dict[str, Any]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "Any" - } - ] - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The permission level of the Actor on Apify platform." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3540, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_permission_level", - "type": { - "name": "ActorPermissionLevel | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorPermissionLevel", - "target": "1795" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A dictionary mapping build tag names to their settings. Use it to create, update,\nor remove build tags. To assign a tag, provide a dict with 'buildId' key. To remove a tag,\nset its value to None. Example: {'latest': {'buildId': 'abc'}, 'beta': None}." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3541, - "kind": 32768, - "kindString": "Parameter", - "name": "tagged_builds", - "type": { - "name": "dict[str, None | dict[str, str]] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "name": "dict", - "typeArguments": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "str" - } - ] - } - ] - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3542, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Actor", - "type": "reference", - "target": "192" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3543, - "module": "_resource_clients.actor", - "name": "delete", - "parsedDocstring": { - "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 707 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor\n" - } - ] - }, - "flags": {}, - "id": 3544, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3545, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3546, - "module": "_resource_clients.actor", - "name": "start", - "parsedDocstring": { - "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n", - "args": { - "run_input": "The input to pass to the Actor run.", - "content_type": "The content type of the input.", - "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest).", - "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit.", - "max_total_charge_usd": "A limit on the total charged amount for pay-per-event Actors.", - "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.", - "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor.", - "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor.", - "force_permission_level": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings.", - "wait_for_finish": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60.", - "webhooks": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The run object." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 717 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The run object." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n" - } - ] - }, - "flags": {}, - "id": 3547, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "start", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The input to pass to the Actor run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3548, - "kind": 32768, - "kindString": "Parameter", - "name": "run_input", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type of the input." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3549, - "kind": 32768, - "kindString": "Parameter", - "name": "content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3550, - "kind": 32768, - "kindString": "Parameter", - "name": "build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3551, - "kind": 32768, - "kindString": "Parameter", - "name": "max_items", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A limit on the total charged amount for pay-per-event Actors." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3552, - "kind": 32768, - "kindString": "Parameter", - "name": "max_total_charge_usd", - "type": { - "name": "Decimal | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Decimal" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3553, - "kind": 32768, - "kindString": "Parameter", - "name": "restart_on_error", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3554, - "kind": 32768, - "kindString": "Parameter", - "name": "memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3555, - "kind": 32768, - "kindString": "Parameter", - "name": "run_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3556, - "kind": 32768, - "kindString": "Parameter", - "name": "force_permission_level", - "type": { - "name": "ActorPermissionLevel | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorPermissionLevel", - "target": "1795" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3557, - "kind": 32768, - "kindString": "Parameter", - "name": "wait_for_finish", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3558, - "kind": 32768, - "kindString": "Parameter", - "name": "webhooks", - "type": { - "name": "WebhooksList | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "WebhooksList", - "target": "14" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3559, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run", - "type": "reference", - "target": "958" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3560, - "module": "_resource_clients.actor", - "name": "call", - "parsedDocstring": { - "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n", - "args": { - "run_input": "The input to pass to the Actor run.", - "content_type": "The content type of the input.", - "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest).", - "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit.", - "max_total_charge_usd": "A limit on the total charged amount for pay-per-event Actors.", - "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.", - "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor.", - "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor.", - "force_permission_level": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings.", - "webhooks": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here.", - "wait_duration": "The maximum time the server waits for the run to finish. If not provided,\nwaits indefinitely.", - "logger": "Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\ndefault logger will be used. Setting `None` will disable any log propagation. Passing custom logger\nwill redirect logs to the provided logger. The logger is also used to capture status and status message\nof the other Actor run.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The run object." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 793 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The run object." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n" - } - ] - }, - "flags": {}, - "id": 3561, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "call", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The input to pass to the Actor run." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3562, - "kind": 32768, - "kindString": "Parameter", - "name": "run_input", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type of the input." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3563, - "kind": 32768, - "kindString": "Parameter", - "name": "content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3564, - "kind": 32768, - "kindString": "Parameter", - "name": "build", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3565, - "kind": 32768, - "kindString": "Parameter", - "name": "max_items", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A limit on the total charged amount for pay-per-event Actors." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3566, - "kind": 32768, - "kindString": "Parameter", - "name": "max_total_charge_usd", - "type": { - "name": "Decimal | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Decimal" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3567, - "kind": 32768, - "kindString": "Parameter", - "name": "restart_on_error", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3568, - "kind": 32768, - "kindString": "Parameter", - "name": "memory_mbytes", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3569, - "kind": 32768, - "kindString": "Parameter", - "name": "run_timeout", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3570, - "kind": 32768, - "kindString": "Parameter", - "name": "webhooks", - "type": { - "name": "WebhooksList | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "WebhooksList", - "target": "14" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3571, - "kind": 32768, - "kindString": "Parameter", - "name": "force_permission_level", - "type": { - "name": "ActorPermissionLevel | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorPermissionLevel", - "target": "1795" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum time the server waits for the run to finish. If not provided,\nwaits indefinitely." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3572, - "kind": 32768, - "kindString": "Parameter", - "name": "wait_duration", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\ndefault logger will be used. Setting `None` will disable any log propagation. Passing custom logger\nwill redirect logs to the provided logger. The logger is also used to capture status and status message\nof the other Actor run." - } - ] - }, - "defaultValue": "'default'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3573, - "kind": 32768, - "kindString": "Parameter", - "name": "logger", - "type": { - "name": "Logger | None | Literal['default']", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "Logger" - }, - { - "type": "literal", - "value": null - } - ] - }, - { - "type": "reference", - "name": "Literal", - "typeArguments": [ - { - "type": "literal", - "value": "default" - } - ] - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'no_timeout'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3574, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Run | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Run", - "target": "958" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3575, - "module": "_resource_clients.actor", - "name": "build", - "parsedDocstring": { - "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n", - "args": { - "version_number": "Actor version number to be built.", - "beta_packages": "If True, then the Actor is built with beta versions of Apify NPM packages. By default,\nthe build uses latest stable packages.", - "tag": "Tag to be applied to the build on success. By default, the tag is taken from the Actor version's\nbuild tag property.", - "use_cache": "If true, the Actor's Docker container will be rebuilt using layer cache\n(https://docs.docker.com/develop/develop-images/dockerfile_best-practices/`leverage`-build-cache).\nThis is to enable quick rebuild during development. By default, the cache is not used.", - "wait_for_finish": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The build object." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 880 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The build object." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n" - } - ] - }, - "flags": {}, - "id": 3576, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "build", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Actor version number to be built." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3577, - "kind": 32768, - "kindString": "Parameter", - "name": "version_number", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If True, then the Actor is built with beta versions of Apify NPM packages. By default,\nthe build uses latest stable packages." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3578, - "kind": 32768, - "kindString": "Parameter", - "name": "beta_packages", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tag to be applied to the build on success. By default, the tag is taken from the Actor version's\nbuild tag property." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3579, - "kind": 32768, - "kindString": "Parameter", - "name": "tag", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the Actor's Docker container will be rebuilt using layer cache\n(https://docs.docker.com/develop/develop-images/dockerfile_best-practices/`leverage`-build-cache).\nThis is to enable quick rebuild during development. By default, the cache is not used." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3580, - "kind": 32768, - "kindString": "Parameter", - "name": "use_cache", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3581, - "kind": 32768, - "kindString": "Parameter", - "name": "wait_for_finish", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3582, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Build", - "type": "reference", - "target": "306" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the builds of this Actor." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3583, - "module": "_resource_clients.actor", - "name": "builds", - "parsedDocstring": { - "text": "Retrieve a client for the builds of this Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 928 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the builds of this Actor." - } - ] - }, - "flags": {}, - "id": 3584, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "builds", - "parameters": [], - "type": { - "name": "BuildCollectionClientAsync", - "type": "reference", - "target": "2795" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the runs of this Actor." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3585, - "module": "_resource_clients.actor", - "name": "runs", - "parsedDocstring": { - "text": "Retrieve a client for the runs of this Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 935 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the runs of this Actor." - } - ] - }, - "flags": {}, - "id": 3586, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "runs", - "parameters": [], - "type": { - "name": "RunCollectionClientAsync", - "type": "reference", - "target": "3939" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3587, - "module": "_resource_clients.actor", - "name": "default_build", - "parsedDocstring": { - "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n", - "args": { - "wait_for_finish": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The resource client for the default build of this Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 942 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The resource client for the default build of this Actor." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n" - } - ] - }, - "flags": {}, - "id": 3588, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "default_build", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3589, - "kind": 32768, - "kindString": "Parameter", - "name": "wait_for_finish", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3590, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "BuildClientAsync", - "type": "reference", - "target": "3195" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3591, - "module": "_resource_clients.actor", - "name": "last_run", - "parsedDocstring": { - "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n", - "args": { - "status": "Consider only runs with this status.", - "origin": "Consider only runs started with this origin.\n" - }, - "returns": "The resource client for the last run of this Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 980 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The resource client for the last run of this Actor." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n" - } - ] - }, - "flags": {}, - "id": 3592, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "last_run", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Consider only runs with this status." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3593, - "kind": 32768, - "kindString": "Parameter", - "name": "status", - "type": { - "name": "ActorJobStatus | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorJobStatus", - "target": "1794" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Consider only runs started with this origin.\n" - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3594, - "kind": 32768, - "kindString": "Parameter", - "name": "origin", - "type": { - "name": "RunOrigin | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "RunOrigin", - "target": "1799" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "RunClientAsync", - "type": "reference", - "target": "3102" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the versions of this Actor." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3595, - "module": "_resource_clients.actor", - "name": "versions", - "parsedDocstring": { - "text": "Retrieve a client for the versions of this Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1007 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for the versions of this Actor." - } - ] - }, - "flags": {}, - "id": 3596, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "versions", - "parameters": [], - "type": { - "name": "ActorVersionCollectionClientAsync", - "type": "reference", - "target": "3298" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the client for the specified version of this Actor.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3597, - "module": "_resource_clients.actor", - "name": "version", - "parsedDocstring": { - "text": "Retrieve the client for the specified version of this Actor.\n", - "args": { - "version_number": "The version number for which to retrieve the resource client.\n" - }, - "returns": "The resource client for the specified Actor version." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1011 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The resource client for the specified Actor version." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the client for the specified version of this Actor.\n" - } - ] - }, - "flags": {}, - "id": 3598, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "version", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The version number for which to retrieve the resource client.\n" - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3599, - "kind": 32768, - "kindString": "Parameter", - "name": "version_number", - "type": { - "name": "str", - "type": "reference" - } - } - ], - "type": { - "name": "ActorVersionClientAsync", - "type": "reference", - "target": "2452" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for webhooks associated with this Actor." - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3600, - "module": "_resource_clients.actor", - "name": "webhooks", - "parsedDocstring": { - "text": "Retrieve a client for webhooks associated with this Actor." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1025 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve a client for webhooks associated with this Actor." - } - ] - }, - "flags": {}, - "id": 3601, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "webhooks", - "parameters": [], - "type": { - "name": "WebhookCollectionClientAsync", - "type": "reference", - "target": "3825" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Validate an input for the Actor that defines an input schema.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3602, - "module": "_resource_clients.actor", - "name": "validate_input", - "parsedDocstring": { - "text": "Validate an input for the Actor that defines an input schema.\n", - "args": { - "run_input": "The input to validate.", - "build_tag": "The Actor's build tag.", - "content_type": "The content type of the input.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "True if the input is valid, else raise an exception with validation error details." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 1029 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "True if the input is valid, else raise an exception with validation error details." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Validate an input for the Actor that defines an input schema.\n" - } - ] - }, - "flags": {}, - "id": 3603, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "validate_input", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The input to validate." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": false - }, - "id": 3604, - "kind": 32768, - "kindString": "Parameter", - "name": "run_input", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Actor's build tag." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3605, - "kind": 32768, - "kindString": "Parameter", - "name": "build_tag", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type of the input." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3606, - "kind": 32768, - "kindString": "Parameter", - "name": "content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3607, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "bool", - "type": "reference" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3985, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific Actor.\n\nProvides methods to manage a specific Actor, e.g. update it, delete it, build it, or start runs. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3507, - 3575, - 3583, - 3560, - 3587, - 3543, - 3512, - 3591, - 3585, - 3546, - 3515, - 3602, - 3597, - 3595, - 3600 - ], - "title": "Methods" - }, - { - "children": [ - 3985 - ], - "title": "Properties" - } - ], - "id": 3506, - "module": "_resource_clients.actor", - "name": "ActorClientAsync", - "parsedDocstring": { - "text": "Sub-client for managing a specific Actor.\n\nProvides methods to manage a specific Actor, e.g. update it, delete it, build it, or start runs. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 563 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3609, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 79 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3614, - "module": "_resource_clients.key_value_store", - "name": "get", - "parsedDocstring": { - "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved key-value store, or None if it does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 92 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved key-value store, or None if it does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n" - } - ] - }, - "flags": {}, - "id": 3615, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3616, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "KeyValueStore | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "KeyValueStore", - "target": "595" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3617, - "module": "_resource_clients.key_value_store", - "name": "update", - "parsedDocstring": { - "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n", - "args": { - "name": "The new name for key-value store.", - "general_access": "Determines how others can access the key-value store.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated key-value store." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 108 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated key-value store." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n" - } - ] - }, - "flags": {}, - "id": 3618, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new name for key-value store." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3619, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines how others can access the key-value store." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3620, - "kind": 32768, - "kindString": "Parameter", - "name": "general_access", - "type": { - "name": "GeneralAccess | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "GeneralAccess", - "target": "1797" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3621, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "KeyValueStore", - "type": "reference", - "target": "595" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3622, - "module": "_resource_clients.key_value_store", - "name": "delete", - "parsedDocstring": { - "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 130 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store\n" - } - ] - }, - "flags": {}, - "id": 3623, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3624, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3625, - "module": "_resource_clients.key_value_store", - "name": "list_keys", - "parsedDocstring": { - "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n", - "args": { - "limit": "Number of keys to be returned. Maximum value is 1000.", - "exclusive_start_key": "All keys up to this one (including) are skipped from the result.", - "collection": "The name of the collection in store schema to list keys from.", - "prefix": "The prefix of the keys to be listed.", - "signature": "Signature used to access the items.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of keys in the key-value store matching the given arguments." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 140 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of keys in the key-value store matching the given arguments." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n" - } - ] - }, - "flags": {}, - "id": 3626, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "list_keys", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of keys to be returned. Maximum value is 1000." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3627, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "All keys up to this one (including) are skipped from the result." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3628, - "kind": 32768, - "kindString": "Parameter", - "name": "exclusive_start_key", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the collection in store schema to list keys from." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3629, - "kind": 32768, - "kindString": "Parameter", - "name": "collection", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prefix of the keys to be listed." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3630, - "kind": 32768, - "kindString": "Parameter", - "name": "prefix", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signature used to access the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3631, - "kind": 32768, - "kindString": "Parameter", - "name": "signature", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3632, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfKeys", - "type": "reference", - "target": "667" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the keys in the key-value store.\n\nSimple `list_keys` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3633, - "module": "_resource_clients.key_value_store", - "name": "iterate_keys", - "parsedDocstring": { - "text": "Iterate over the keys in the key-value store.\n\nSimple `list_keys` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n", - "args": { - "limit": "Maximum number of keys to return. By default there is no limit.", - "exclusive_start_key": "All keys up to this one (including) are skipped from the result.", - "collection": "The name of the collection in store schema to list keys from.", - "prefix": "The prefix of the keys to be listed.", - "signature": "Signature used to access the items.", - "chunk_size": "Maximum number of keys requested per API call when iterating across pages.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 183 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the keys in the key-value store.\n\nSimple `list_keys` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n" - } - ] - }, - "flags": {}, - "id": 3634, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate_keys", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of keys to return. By default there is no limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3635, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "All keys up to this one (including) are skipped from the result." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3636, - "kind": 32768, - "kindString": "Parameter", - "name": "exclusive_start_key", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the collection in store schema to list keys from." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3637, - "kind": 32768, - "kindString": "Parameter", - "name": "collection", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prefix of the keys to be listed." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3638, - "kind": 32768, - "kindString": "Parameter", - "name": "prefix", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signature used to access the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3639, - "kind": 32768, - "kindString": "Parameter", - "name": "signature", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of keys requested per API call when iterating across pages." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3640, - "kind": 32768, - "kindString": "Parameter", - "name": "chunk_size", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3641, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "KeyValueStoreKey", - "target": "611" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3642, - "module": "_resource_clients.key_value_store", - "name": "get_record", - "parsedDocstring": { - "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n", - "args": { - "key": "Key of the record to retrieve.", - "signature": "Signature used to access the items.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The requested record, or None, if the record does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 231 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The requested record, or None, if the record does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" - } - ] - }, - "flags": {}, - "id": 3643, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_record", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Key of the record to retrieve." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3644, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signature used to access the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3645, - "kind": 32768, - "kindString": "Parameter", - "name": "signature", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3646, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3647, - "module": "_resource_clients.key_value_store", - "name": "record_exists", - "parsedDocstring": { - "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n", - "args": { - "key": "Key of the record to check.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "True if the record exists, False otherwise." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 263 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "True if the record exists, False otherwise." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n" - } - ] - }, - "flags": {}, - "id": 3648, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "record_exists", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Key of the record to check." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3649, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3650, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "bool", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3651, - "module": "_resource_clients.key_value_store", - "name": "get_record_as_bytes", - "parsedDocstring": { - "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n", - "args": { - "key": "Key of the record to retrieve.", - "signature": "Signature used to access the items.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The requested record, or None, if the record does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 290 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The requested record, or None, if the record does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" - } - ] - }, - "flags": {}, - "id": 3652, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_record_as_bytes", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Key of the record to retrieve." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3653, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signature used to access the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3654, - "kind": 32768, - "kindString": "Parameter", - "name": "signature", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3655, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" - } - ] - }, - "decorations": [ - { - "name": "contextmanager" - } - ], - "flags": {}, - "groups": [], - "id": 3656, - "module": "_resource_clients.key_value_store", - "name": "stream_record", - "parsedDocstring": { - "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n", - "args": { - "key": "Key of the record to retrieve.", - "signature": "Signature used to access the items.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The requested record as a context-managed streaming Response, or None, if the record does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 323 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The requested record as a context-managed streaming Response, or None, if the record does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" - } - ] - }, - "flags": {}, - "id": 3657, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "stream_record", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Key of the record to retrieve." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3658, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signature used to access the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3659, - "kind": 32768, - "kindString": "Parameter", - "name": "signature", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3660, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3661, - "module": "_resource_clients.key_value_store", - "name": "set_record", - "parsedDocstring": { - "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n", - "args": { - "key": "The key of the record to save the value to.", - "value": "The value to save into the record.", - "content_type": "The content type of the saved value.", - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 361 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n" - } - ] - }, - "flags": {}, - "id": 3662, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "set_record", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The key of the record to save the value to." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3663, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to save into the record." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3664, - "kind": 32768, - "kindString": "Parameter", - "name": "value", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type of the saved value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3665, - "kind": 32768, - "kindString": "Parameter", - "name": "content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3666, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3667, - "module": "_resource_clients.key_value_store", - "name": "delete_record", - "parsedDocstring": { - "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n", - "args": { - "key": "The key of the record which to delete.", - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 392 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n" - } - ] - }, - "flags": {}, - "id": 3668, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "delete_record", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The key of the record which to delete." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3669, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3670, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3671, - "module": "_resource_clients.key_value_store", - "name": "get_record_public_url", - "parsedDocstring": { - "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n", - "args": { - "key": "The key for which the URL should be generated.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "A public URL that can be used to access the value of the given key in the KVS." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 408 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A public URL that can be used to access the value of the given key in the KVS." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n" - } - ] - }, - "flags": {}, - "id": 3672, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get_record_public_url", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The key for which the URL should be generated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3673, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3674, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "str", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3675, - "module": "_resource_clients.key_value_store", - "name": "create_keys_public_url", - "parsedDocstring": { - "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n", - "args": { - "limit": "Number of keys to be returned. Maximum value is 1000.", - "exclusive_start_key": "All keys up to this one (including) are skipped from the result.", - "collection": "The name of the collection in store schema to list keys from.", - "prefix": "The prefix of the keys to be listed.", - "expires_in": "How long the signed URL should be valid from the time it is generated.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The public key-value store keys URL." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 439 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The public key-value store keys URL." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n" - } - ] - }, - "flags": {}, - "id": 3676, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "create_keys_public_url", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of keys to be returned. Maximum value is 1000." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3677, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "All keys up to this one (including) are skipped from the result." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3678, - "kind": 32768, - "kindString": "Parameter", - "name": "exclusive_start_key", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the collection in store schema to list keys from." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3679, - "kind": 32768, - "kindString": "Parameter", - "name": "collection", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prefix of the keys to be listed." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3680, - "kind": 32768, - "kindString": "Parameter", - "name": "prefix", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How long the signed URL should be valid from the time it is generated." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3681, - "kind": 32768, - "kindString": "Parameter", - "name": "expires_in", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3682, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "str", - "type": "reference" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 4013, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific key-value store.\n\nProvides methods to manage a specific key-value store, e.g. get it, update it, or manage its records. Obtain an\ninstance via an appropriate method on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3609, - 3675, - 3622, - 3667, - 3614, - 3642, - 3651, - 3671, - 3633, - 3625, - 3647, - 3661, - 3656, - 3617 - ], - "title": "Methods" - }, - { - "children": [ - 4013 - ], - "title": "Properties" - } - ], - "id": 3608, - "module": "_resource_clients.key_value_store", - "name": "KeyValueStoreClient", - "parsedDocstring": { - "text": "Sub-client for managing a specific key-value store.\n\nProvides methods to manage a specific key-value store, e.g. get it, update it, or manage its records. Obtain an\ninstance via an appropriate method on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3684, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 505 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3689, - "module": "_resource_clients.key_value_store", - "name": "get", - "parsedDocstring": { - "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved key-value store, or None if it does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 518 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved key-value store, or None if it does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n" - } - ] - }, - "flags": {}, - "id": 3690, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3691, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "KeyValueStore | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "KeyValueStore", - "target": "595" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3692, - "module": "_resource_clients.key_value_store", - "name": "update", - "parsedDocstring": { - "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n", - "args": { - "name": "The new name for key-value store.", - "general_access": "Determines how others can access the key-value store.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated key-value store." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 534 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated key-value store." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n" - } - ] - }, - "flags": {}, - "id": 3693, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new name for key-value store." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3694, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines how others can access the key-value store." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3695, - "kind": 32768, - "kindString": "Parameter", - "name": "general_access", - "type": { - "name": "GeneralAccess | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "GeneralAccess", - "target": "1797" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3696, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "KeyValueStore", - "type": "reference", - "target": "595" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3697, - "module": "_resource_clients.key_value_store", - "name": "delete", - "parsedDocstring": { - "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 556 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store\n" - } - ] - }, - "flags": {}, - "id": 3698, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3699, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3700, - "module": "_resource_clients.key_value_store", - "name": "list_keys", - "parsedDocstring": { - "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n", - "args": { - "limit": "Number of keys to be returned. Maximum value is 1000.", - "exclusive_start_key": "All keys up to this one (including) are skipped from the result.", - "collection": "The name of the collection in store schema to list keys from.", - "prefix": "The prefix of the keys to be listed.", - "signature": "Signature used to access the items.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of keys in the key-value store matching the given arguments." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 566 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of keys in the key-value store matching the given arguments." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n" - } - ] - }, - "flags": {}, - "id": 3701, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "list_keys", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of keys to be returned. Maximum value is 1000." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3702, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "All keys up to this one (including) are skipped from the result." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3703, - "kind": 32768, - "kindString": "Parameter", - "name": "exclusive_start_key", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the collection in store schema to list keys from." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3704, - "kind": 32768, - "kindString": "Parameter", - "name": "collection", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prefix of the keys to be listed." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3705, - "kind": 32768, - "kindString": "Parameter", - "name": "prefix", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signature used to access the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3706, - "kind": 32768, - "kindString": "Parameter", - "name": "signature", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3707, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfKeys", - "type": "reference", - "target": "667" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the keys in the key-value store.\n\nSimple `list_keys` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3708, - "module": "_resource_clients.key_value_store", - "name": "iterate_keys", - "parsedDocstring": { - "text": "Iterate over the keys in the key-value store.\n\nSimple `list_keys` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n", - "args": { - "limit": "Maximum number of keys to return. By default there is no limit.", - "exclusive_start_key": "All keys up to this one (including) are skipped from the result.", - "collection": "The name of the collection in store schema to list keys from.", - "prefix": "The prefix of the keys to be listed.", - "signature": "Signature used to access the items.", - "chunk_size": "Maximum number of keys requested per API call when iterating across pages.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 609 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the keys in the key-value store.\n\nSimple `list_keys` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n" - } - ] - }, - "flags": {}, - "id": 3709, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate_keys", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of keys to return. By default there is no limit." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3710, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "All keys up to this one (including) are skipped from the result." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3711, - "kind": 32768, - "kindString": "Parameter", - "name": "exclusive_start_key", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the collection in store schema to list keys from." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3712, - "kind": 32768, - "kindString": "Parameter", - "name": "collection", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prefix of the keys to be listed." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3713, - "kind": 32768, - "kindString": "Parameter", - "name": "prefix", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signature used to access the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3714, - "kind": 32768, - "kindString": "Parameter", - "name": "signature", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of keys requested per API call when iterating across pages." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3715, - "kind": 32768, - "kindString": "Parameter", - "name": "chunk_size", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3716, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "KeyValueStoreKey", - "target": "611" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3717, - "module": "_resource_clients.key_value_store", - "name": "get_record", - "parsedDocstring": { - "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n", - "args": { - "key": "Key of the record to retrieve.", - "signature": "Signature used to access the items.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The requested record, or None, if the record does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 657 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The requested record, or None, if the record does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" - } - ] - }, - "flags": {}, - "id": 3718, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_record", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Key of the record to retrieve." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3719, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signature used to access the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3720, - "kind": 32768, - "kindString": "Parameter", - "name": "signature", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3721, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3722, - "module": "_resource_clients.key_value_store", - "name": "record_exists", - "parsedDocstring": { - "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n", - "args": { - "key": "Key of the record to check.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "True if the record exists, False otherwise." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 689 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "True if the record exists, False otherwise." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n" - } - ] - }, - "flags": {}, - "id": 3723, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "record_exists", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Key of the record to check." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3724, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3725, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "bool", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3726, - "module": "_resource_clients.key_value_store", - "name": "get_record_as_bytes", - "parsedDocstring": { - "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n", - "args": { - "key": "Key of the record to retrieve.", - "signature": "Signature used to access the items.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The requested record, or None, if the record does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 716 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The requested record, or None, if the record does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" - } - ] - }, - "flags": {}, - "id": 3727, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_record_as_bytes", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Key of the record to retrieve." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3728, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signature used to access the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3729, - "kind": 32768, - "kindString": "Parameter", - "name": "signature", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3730, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" - } - ] - }, - "decorations": [ - { - "name": "asynccontextmanager" - } - ], - "flags": {}, - "groups": [], - "id": 3731, - "module": "_resource_clients.key_value_store", - "name": "stream_record", - "parsedDocstring": { - "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n", - "args": { - "key": "Key of the record to retrieve.", - "signature": "Signature used to access the items.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The requested record as a context-managed streaming Response, or None, if the record does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 751 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The requested record as a context-managed streaming Response, or None, if the record does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" - } - ] - }, - "flags": {}, - "id": 3732, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "stream_record", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Key of the record to retrieve." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3733, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Signature used to access the items." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3734, - "kind": 32768, - "kindString": "Parameter", - "name": "signature", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3735, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3736, - "module": "_resource_clients.key_value_store", - "name": "set_record", - "parsedDocstring": { - "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n", - "args": { - "key": "The key of the record to save the value to.", - "value": "The value to save into the record.", - "content_type": "The content type of the saved value.", - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 789 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n" - } - ] - }, - "flags": {}, - "id": 3737, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "set_record", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The key of the record to save the value to." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3738, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to save into the record." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3739, - "kind": 32768, - "kindString": "Parameter", - "name": "value", - "type": { - "name": "Any", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content type of the saved value." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3740, - "kind": 32768, - "kindString": "Parameter", - "name": "content_type", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3741, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3742, - "module": "_resource_clients.key_value_store", - "name": "delete_record", - "parsedDocstring": { - "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n", - "args": { - "key": "The key of the record which to delete.", - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 820 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n" - } - ] - }, - "flags": {}, - "id": 3743, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "delete_record", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The key of the record which to delete." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3744, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3745, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3746, - "module": "_resource_clients.key_value_store", - "name": "get_record_public_url", - "parsedDocstring": { - "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n", - "args": { - "key": "The key for which the URL should be generated.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "A public URL that can be used to access the value of the given key in the KVS." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 836 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A public URL that can be used to access the value of the given key in the KVS." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n" - } - ] - }, - "flags": {}, - "id": 3747, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get_record_public_url", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The key for which the URL should be generated." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": false - }, - "id": 3748, - "kind": 32768, - "kindString": "Parameter", - "name": "key", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3749, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "str", - "type": "reference" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3750, - "module": "_resource_clients.key_value_store", - "name": "create_keys_public_url", - "parsedDocstring": { - "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n", - "args": { - "limit": "Number of keys to be returned. Maximum value is 1000.", - "exclusive_start_key": "All keys up to this one (including) are skipped from the result.", - "collection": "The name of the collection in store schema to list keys from.", - "prefix": "The prefix of the keys to be listed.", - "expires_in": "How long the signed URL should be valid from the time it is generated.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The public key-value store keys URL." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 867 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The public key-value store keys URL." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n" - } - ] - }, - "flags": {}, - "id": 3751, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "create_keys_public_url", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of keys to be returned. Maximum value is 1000." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3752, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "All keys up to this one (including) are skipped from the result." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3753, - "kind": 32768, - "kindString": "Parameter", - "name": "exclusive_start_key", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the collection in store schema to list keys from." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3754, - "kind": 32768, - "kindString": "Parameter", - "name": "collection", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prefix of the keys to be listed." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3755, - "kind": 32768, - "kindString": "Parameter", - "name": "prefix", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How long the signed URL should be valid from the time it is generated." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3756, - "kind": 32768, - "kindString": "Parameter", - "name": "expires_in", - "type": { - "name": "timedelta | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "timedelta" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'long'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3757, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "str", - "type": "reference" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3986, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific key-value store.\n\nProvides methods to manage a specific key-value store, e.g. get it, update it, or manage its records. Obtain an\ninstance via an appropriate method on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3684, - 3750, - 3697, - 3742, - 3689, - 3717, - 3726, - 3746, - 3708, - 3700, - 3722, - 3736, - 3731, - 3692 - ], - "title": "Methods" - }, - { - "children": [ - 3986 - ], - "title": "Properties" - } - ], - "id": 3683, - "module": "_resource_clients.key_value_store", - "name": "KeyValueStoreClientAsync", - "parsedDocstring": { - "text": "Sub-client for managing a specific key-value store.\n\nProvides methods to manage a specific key-value store, e.g. get it, update it, or manage its records. Obtain an\ninstance via an appropriate method on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/key_value_store.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 498 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3759, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 21 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3764, - "module": "_resource_clients.actor_env_var", - "name": "get", - "parsedDocstring": { - "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved Actor environment variable data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 34 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved Actor environment variable data." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n" - } - ] - }, - "flags": {}, - "id": 3765, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3766, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "EnvVar | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "EnvVar", - "target": "541" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3767, - "module": "_resource_clients.actor_env_var", - "name": "update", - "parsedDocstring": { - "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n", - "args": { - "is_secret": "Whether the environment variable is secret or not.", - "name": "The name of the environment variable.", - "value": "The value of the environment variable.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated Actor environment variable." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 50 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated Actor environment variable." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n" - } - ] - }, - "flags": {}, - "id": 3768, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the environment variable is secret or not." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3769, - "kind": 32768, - "kindString": "Parameter", - "name": "is_secret", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the environment variable." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3770, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value of the environment variable." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3771, - "kind": 32768, - "kindString": "Parameter", - "name": "value", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3772, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "EnvVar", - "type": "reference", - "target": "541" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3773, - "module": "_resource_clients.actor_env_var", - "name": "delete", - "parsedDocstring": { - "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 77 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable\n" - } - ] - }, - "flags": {}, - "id": 3774, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3775, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 4014, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific Actor environment variable.\n\nProvides methods to manage a specific Actor environment variable, e.g. get, update, or delete it. Obtain an instance\nvia an appropriate method on the `ActorVersionClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3759, - 3773, - 3764, - 3767 - ], - "title": "Methods" - }, - { - "children": [ - 4014 - ], - "title": "Properties" - } - ], - "id": 3758, - "module": "_resource_clients.actor_env_var", - "name": "ActorEnvVarClient", - "parsedDocstring": { - "text": "Sub-client for managing a specific Actor environment variable.\n\nProvides methods to manage a specific Actor environment variable, e.g. get, update, or delete it. Obtain an instance\nvia an appropriate method on the `ActorVersionClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 14 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3777, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 96 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3782, - "module": "_resource_clients.actor_env_var", - "name": "get", - "parsedDocstring": { - "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved Actor environment variable data." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 109 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved Actor environment variable data." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n" - } - ] - }, - "flags": {}, - "id": 3783, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3784, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "EnvVar | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "EnvVar", - "target": "541" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3785, - "module": "_resource_clients.actor_env_var", - "name": "update", - "parsedDocstring": { - "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n", - "args": { - "is_secret": "Whether the environment variable is secret or not.", - "name": "The name of the environment variable.", - "value": "The value of the environment variable.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated Actor environment variable." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 125 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated Actor environment variable." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n" - } - ] - }, - "flags": {}, - "id": 3786, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the environment variable is secret or not." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3787, - "kind": 32768, - "kindString": "Parameter", - "name": "is_secret", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the environment variable." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3788, - "kind": 32768, - "kindString": "Parameter", - "name": "name", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value of the environment variable." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3789, - "kind": 32768, - "kindString": "Parameter", - "name": "value", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3790, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "EnvVar", - "type": "reference", - "target": "541" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3791, - "module": "_resource_clients.actor_env_var", - "name": "delete", - "parsedDocstring": { - "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 152 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable\n" - } - ] - }, - "flags": {}, - "id": 3792, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3793, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3987, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific Actor environment variable.\n\nProvides methods to manage a specific Actor environment variable, e.g. get, update, or delete it. Obtain an instance\nvia an appropriate method on the `ActorVersionClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3777, - 3791, - 3782, - 3785 - ], - "title": "Methods" - }, - { - "children": [ - 3987 - ], - "title": "Properties" - } - ], - "id": 3776, - "module": "_resource_clients.actor_env_var", - "name": "ActorEnvVarClientAsync", - "parsedDocstring": { - "text": "Sub-client for managing a specific Actor environment variable.\n\nProvides methods to manage a specific Actor environment variable, e.g. get, update, or delete it. Obtain an instance\nvia an appropriate method on the `ActorVersionClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 89 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3795, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 32 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3799, - "module": "_resource_clients.webhook_collection", - "name": "list", - "parsedDocstring": { - "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n", - "args": { - "limit": "How many webhooks to retrieve.", - "offset": "What webhook to include as first when retrieving the list.", - "desc": "Whether to sort the webhooks in descending order based on their date of creation.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available webhooks matching the specified filters." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 43 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available webhooks matching the specified filters." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n" - } - ] - }, - "flags": {}, - "id": 3800, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many webhooks to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3801, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What webhook to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3802, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the webhooks in descending order based on their date of creation." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3803, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3804, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfWebhooks", - "type": "reference", - "target": "783" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available webhooks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3805, - "module": "_resource_clients.webhook_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over the available webhooks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n", - "args": { - "limit": "How many webhooks to retrieve.", - "offset": "What webhook to include as first when retrieving the list.", - "desc": "Whether to sort the webhooks in descending order based on their date of creation.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 67 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available webhooks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n" - } - ] - }, - "flags": {}, - "id": 3806, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many webhooks to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3807, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What webhook to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3808, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the webhooks in descending order based on their date of creation." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3809, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3810, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookShort", - "target": "1406" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3811, - "module": "_resource_clients.webhook_collection", - "name": "create", - "parsedDocstring": { - "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n", - "args": { - "event_types": "List of event types that should trigger the webhook. At least one is required.", - "request_url": "URL that will be invoked once the webhook is triggered.", - "payload_template": "Specification of the payload that will be sent to request_url.", - "headers_template": "Headers that will be sent to the request_url.", - "actor_id": "Id of the Actor whose runs should trigger the webhook.", - "actor_task_id": "Id of the Actor task whose runs should trigger the webhook.", - "actor_run_id": "Id of the Actor run which should trigger the webhook.", - "ignore_ssl_errors": "Whether the webhook should ignore SSL errors returned by request_url.", - "do_not_retry": "Whether the webhook should retry sending the payload to request_url upon failure.", - "idempotency_key": "A unique identifier of a webhook. You can use it to ensure that you won't create\nthe same webhook multiple times.", - "is_ad_hoc": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The created webhook." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 97 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The created webhook." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n" - } - ] - }, - "flags": {}, - "id": 3812, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "create", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of event types that should trigger the webhook. At least one is required." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3813, - "kind": 32768, - "kindString": "Parameter", - "name": "event_types", - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookEventType", - "target": "1804" - } - ], - "target": "2199" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL that will be invoked once the webhook is triggered." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3814, - "kind": 32768, - "kindString": "Parameter", - "name": "request_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specification of the payload that will be sent to request_url." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3815, - "kind": 32768, - "kindString": "Parameter", - "name": "payload_template", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Headers that will be sent to the request_url." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3816, - "kind": 32768, - "kindString": "Parameter", - "name": "headers_template", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Id of the Actor whose runs should trigger the webhook." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3817, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Id of the Actor task whose runs should trigger the webhook." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3818, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_task_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Id of the Actor run which should trigger the webhook." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3819, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_run_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the webhook should ignore SSL errors returned by request_url." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3820, - "kind": 32768, - "kindString": "Parameter", - "name": "ignore_ssl_errors", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the webhook should retry sending the payload to request_url upon failure." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3821, - "kind": 32768, - "kindString": "Parameter", - "name": "do_not_retry", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier of a webhook. You can use it to ensure that you won't create\nthe same webhook multiple times." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3822, - "kind": 32768, - "kindString": "Parameter", - "name": "idempotency_key", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3823, - "kind": 32768, - "kindString": "Parameter", - "name": "is_ad_hoc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3824, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Webhook", - "type": "reference", - "target": "1350" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 4015, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the webhook collection.\n\nProvides methods to manage the webhook collection, e.g. list or create webhooks. Obtain an instance via an\nappropriate method on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3795, - 3811, - 3805, - 3799 - ], - "title": "Methods" - }, - { - "children": [ - 4015 - ], - "title": "Properties" - } - ], - "id": 3794, - "module": "_resource_clients.webhook_collection", - "name": "WebhookCollectionClient", - "parsedDocstring": { - "text": "Sub-client for the webhook collection.\n\nProvides methods to manage the webhook collection, e.g. list or create webhooks. Obtain an instance via an\nappropriate method on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 25 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3826, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 165 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3830, - "module": "_resource_clients.webhook_collection", - "name": "list", - "parsedDocstring": { - "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n", - "args": { - "limit": "How many webhooks to retrieve.", - "offset": "What webhook to include as first when retrieving the list.", - "desc": "Whether to sort the webhooks in descending order based on their date of creation.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The list of available webhooks matching the specified filters." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 176 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The list of available webhooks matching the specified filters." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n" - } - ] - }, - "flags": {}, - "id": 3831, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many webhooks to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3832, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What webhook to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3833, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the webhooks in descending order based on their date of creation." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3834, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3835, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfWebhooks", - "type": "reference", - "target": "783" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available webhooks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3836, - "module": "_resource_clients.webhook_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over the available webhooks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n", - "args": { - "limit": "How many webhooks to retrieve.", - "offset": "What webhook to include as first when retrieving the list.", - "desc": "Whether to sort the webhooks in descending order based on their date of creation.", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 200 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over the available webhooks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n" - } - ] - }, - "flags": {}, - "id": 3837, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many webhooks to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3838, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What webhook to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3839, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the webhooks in descending order based on their date of creation." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3840, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3841, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookShort", - "target": "1406" - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3842, - "module": "_resource_clients.webhook_collection", - "name": "create", - "parsedDocstring": { - "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n", - "args": { - "event_types": "List of event types that should trigger the webhook. At least one is required.", - "request_url": "URL that will be invoked once the webhook is triggered.", - "payload_template": "Specification of the payload that will be sent to request_url.", - "headers_template": "Headers that will be sent to the request_url.", - "actor_id": "Id of the Actor whose runs should trigger the webhook.", - "actor_task_id": "Id of the Actor task whose runs should trigger the webhook.", - "actor_run_id": "Id of the Actor run which should trigger the webhook.", - "ignore_ssl_errors": "Whether the webhook should ignore SSL errors returned by request_url.", - "do_not_retry": "Whether the webhook should retry sending the payload to request_url upon failure.", - "idempotency_key": "A unique identifier of a webhook. You can use it to ensure that you won't create\nthe same webhook multiple times.", - "is_ad_hoc": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The created webhook." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 230 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The created webhook." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n" - } - ] - }, - "flags": {}, - "id": 3843, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "create", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of event types that should trigger the webhook. At least one is required." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3844, - "kind": 32768, - "kindString": "Parameter", - "name": "event_types", - "type": { - "name": "list", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookEventType", - "target": "1804" - } - ], - "target": "2199" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL that will be invoked once the webhook is triggered." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3845, - "kind": 32768, - "kindString": "Parameter", - "name": "request_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specification of the payload that will be sent to request_url." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3846, - "kind": 32768, - "kindString": "Parameter", - "name": "payload_template", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Headers that will be sent to the request_url." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3847, - "kind": 32768, - "kindString": "Parameter", - "name": "headers_template", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Id of the Actor whose runs should trigger the webhook." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3848, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Id of the Actor task whose runs should trigger the webhook." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3849, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_task_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Id of the Actor run which should trigger the webhook." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3850, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_run_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the webhook should ignore SSL errors returned by request_url." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3851, - "kind": 32768, - "kindString": "Parameter", - "name": "ignore_ssl_errors", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the webhook should retry sending the payload to request_url upon failure." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3852, - "kind": 32768, - "kindString": "Parameter", - "name": "do_not_retry", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique identifier of a webhook. You can use it to ensure that you won't create\nthe same webhook multiple times." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3853, - "kind": 32768, - "kindString": "Parameter", - "name": "idempotency_key", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3854, - "kind": 32768, - "kindString": "Parameter", - "name": "is_ad_hoc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3855, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Webhook", - "type": "reference", - "target": "1350" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3988, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the webhook collection.\n\nProvides methods to manage the webhook collection, e.g. list or create webhooks. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3826, - 3842, - 3836, - 3830 - ], - "title": "Methods" - }, - { - "children": [ - 3988 - ], - "title": "Properties" - } - ], - "id": 3825, - "module": "_resource_clients.webhook_collection", - "name": "WebhookCollectionClientAsync", - "parsedDocstring": { - "text": "Sub-client for the webhook collection.\n\nProvides methods to manage the webhook collection, e.g. list or create webhooks. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 158 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3857, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 33 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3862, - "module": "_resource_clients.webhook", - "name": "get", - "parsedDocstring": { - "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved webhook, or None if it does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 46 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved webhook, or None if it does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n" - } - ] - }, - "flags": {}, - "id": 3863, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3864, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Webhook | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Webhook", - "target": "1350" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3865, - "module": "_resource_clients.webhook", - "name": "update", - "parsedDocstring": { - "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n", - "args": { - "event_types": "List of event types that should trigger the webhook. At least one is required.", - "request_url": "URL that will be invoked once the webhook is triggered.", - "payload_template": "Specification of the payload that will be sent to request_url.", - "headers_template": "Headers that will be sent to the request_url.", - "actor_id": "Id of the Actor whose runs should trigger the webhook.", - "actor_task_id": "Id of the Actor task whose runs should trigger the webhook.", - "actor_run_id": "Id of the Actor run which should trigger the webhook.", - "ignore_ssl_errors": "Whether the webhook should ignore SSL errors returned by request_url.", - "do_not_retry": "Whether the webhook should retry sending the payload to request_url upon failure.", - "is_ad_hoc": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated webhook." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 62 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated webhook." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n" - } - ] - }, - "flags": {}, - "id": 3866, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of event types that should trigger the webhook. At least one is required." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3867, - "kind": 32768, - "kindString": "Parameter", - "name": "event_types", - "type": { - "name": "list[WebhookEventType] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookEventType", - "target": "1804" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL that will be invoked once the webhook is triggered." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3868, - "kind": 32768, - "kindString": "Parameter", - "name": "request_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specification of the payload that will be sent to request_url." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3869, - "kind": 32768, - "kindString": "Parameter", - "name": "payload_template", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Headers that will be sent to the request_url." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3870, - "kind": 32768, - "kindString": "Parameter", - "name": "headers_template", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Id of the Actor whose runs should trigger the webhook." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3871, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Id of the Actor task whose runs should trigger the webhook." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3872, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_task_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Id of the Actor run which should trigger the webhook." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3873, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_run_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the webhook should ignore SSL errors returned by request_url." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3874, - "kind": 32768, - "kindString": "Parameter", - "name": "ignore_ssl_errors", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the webhook should retry sending the payload to request_url upon failure." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3875, - "kind": 32768, - "kindString": "Parameter", - "name": "do_not_retry", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3876, - "kind": 32768, - "kindString": "Parameter", - "name": "is_ad_hoc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3877, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Webhook", - "type": "reference", - "target": "1350" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3878, - "module": "_resource_clients.webhook", - "name": "delete", - "parsedDocstring": { - "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 115 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook\n" - } - ] - }, - "flags": {}, - "id": 3879, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3880, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3881, - "module": "_resource_clients.webhook", - "name": "test", - "parsedDocstring": { - "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The webhook dispatch created by the test." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 125 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The webhook dispatch created by the test." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n" - } - ] - }, - "flags": {}, - "id": 3882, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "test", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3883, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "WebhookDispatch", - "type": "reference", - "target": "1386" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3884, - "module": "_resource_clients.webhook", - "name": "dispatches", - "parsedDocstring": { - "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n", - "returns": "A client allowing access to dispatches of this webhook using its list method." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 151 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A client allowing access to dispatches of this webhook using its list method." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n" - } - ] - }, - "flags": {}, - "id": 3885, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "dispatches", - "parameters": [], - "type": { - "name": "WebhookDispatchCollectionClient", - "type": "reference", - "target": "2228" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 4016, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific webhook.\n\nProvides methods to manage a specific webhook, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3857, - 3878, - 3884, - 3862, - 3881, - 3865 - ], - "title": "Methods" - }, - { - "children": [ - 4016 - ], - "title": "Properties" - } - ], - "id": 3856, - "module": "_resource_clients.webhook", - "name": "WebhookClient", - "parsedDocstring": { - "text": "Sub-client for managing a specific webhook.\n\nProvides methods to manage a specific webhook, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 26 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3887, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 173 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3892, - "module": "_resource_clients.webhook", - "name": "get", - "parsedDocstring": { - "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved webhook, or None if it does not exist." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 186 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved webhook, or None if it does not exist." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n" - } - ] - }, - "flags": {}, - "id": 3893, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "get", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3894, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Webhook | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "Webhook", - "target": "1350" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3895, - "module": "_resource_clients.webhook", - "name": "update", - "parsedDocstring": { - "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n", - "args": { - "event_types": "List of event types that should trigger the webhook. At least one is required.", - "request_url": "URL that will be invoked once the webhook is triggered.", - "payload_template": "Specification of the payload that will be sent to request_url.", - "headers_template": "Headers that will be sent to the request_url.", - "actor_id": "Id of the Actor whose runs should trigger the webhook.", - "actor_task_id": "Id of the Actor task whose runs should trigger the webhook.", - "actor_run_id": "Id of the Actor run which should trigger the webhook.", - "ignore_ssl_errors": "Whether the webhook should ignore SSL errors returned by request_url.", - "do_not_retry": "Whether the webhook should retry sending the payload to request_url upon failure.", - "is_ad_hoc": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled.", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The updated webhook." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 202 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The updated webhook." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n" - } - ] - }, - "flags": {}, - "id": 3896, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "update", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of event types that should trigger the webhook. At least one is required." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3897, - "kind": 32768, - "kindString": "Parameter", - "name": "event_types", - "type": { - "name": "list[WebhookEventType] | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "WebhookEventType", - "target": "1804" - } - ], - "target": "2199" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL that will be invoked once the webhook is triggered." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3898, - "kind": 32768, - "kindString": "Parameter", - "name": "request_url", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specification of the payload that will be sent to request_url." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3899, - "kind": 32768, - "kindString": "Parameter", - "name": "payload_template", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Headers that will be sent to the request_url." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3900, - "kind": 32768, - "kindString": "Parameter", - "name": "headers_template", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Id of the Actor whose runs should trigger the webhook." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3901, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Id of the Actor task whose runs should trigger the webhook." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3902, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_task_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Id of the Actor run which should trigger the webhook." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3903, - "kind": 32768, - "kindString": "Parameter", - "name": "actor_run_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the webhook should ignore SSL errors returned by request_url." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3904, - "kind": 32768, - "kindString": "Parameter", - "name": "ignore_ssl_errors", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the webhook should retry sending the payload to request_url upon failure." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3905, - "kind": 32768, - "kindString": "Parameter", - "name": "do_not_retry", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3906, - "kind": 32768, - "kindString": "Parameter", - "name": "is_ad_hoc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3907, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Webhook", - "type": "reference", - "target": "1350" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3908, - "module": "_resource_clients.webhook", - "name": "delete", - "parsedDocstring": { - "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook\n", - "args": { - "timeout": "Timeout for the API HTTP request." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 255 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook\n" - } - ] - }, - "flags": {}, - "id": 3909, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "delete", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request." - } - ] - }, - "defaultValue": "'short'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3910, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3911, - "module": "_resource_clients.webhook", - "name": "test", - "parsedDocstring": { - "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n", - "args": { - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The webhook dispatch created by the test." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 265 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The webhook dispatch created by the test." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n" - } - ] - }, - "flags": {}, - "id": 3912, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "test", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3913, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "WebhookDispatch", - "type": "reference", - "target": "1386" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3914, - "module": "_resource_clients.webhook", - "name": "dispatches", - "parsedDocstring": { - "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n", - "returns": "A client allowing access to dispatches of this webhook using its list method." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 291 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "A client allowing access to dispatches of this webhook using its list method." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n" - } - ] - }, - "flags": {}, - "id": 3915, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "dispatches", - "parameters": [], - "type": { - "name": "WebhookDispatchCollectionClientAsync", - "type": "reference", - "target": "2245" - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3989, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for managing a specific webhook.\n\nProvides methods to manage a specific webhook, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3887, - 3908, - 3914, - 3892, - 3911, - 3895 - ], - "title": "Methods" - }, - { - "children": [ - 3989 - ], - "title": "Properties" - } - ], - "id": 3886, - "module": "_resource_clients.webhook", - "name": "WebhookClientAsync", - "parsedDocstring": { - "text": "Sub-client for managing a specific webhook.\n\nProvides methods to manage a specific webhook, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/webhook.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 166 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3917, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 27 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3386, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3387, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3388, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3389, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClient", - "type": "reference", - "target": "1836" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3390, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3391, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistry", - "type": "reference", - "target": "1710" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3392, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3393, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClient.__init__", - "target": 3385, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3921, - "module": "_resource_clients.run_collection", - "name": "list", - "parsedDocstring": { - "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n", - "args": { - "limit": "How many runs to retrieve.", - "offset": "What run to include as first when retrieving the list.", - "desc": "Whether to sort the runs in descending order based on their start date.", - "status": "Retrieve only runs with the provided statuses.", - "started_before": "Only return runs started before this date (inclusive).", - "started_after": "Only return runs started after this date (inclusive).", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved Actor runs." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 38 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved Actor runs." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n" - } - ] - }, - "flags": {}, - "id": 3922, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many runs to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3923, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What run to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3924, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the runs in descending order based on their start date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3925, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve only runs with the provided statuses." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3926, - "kind": 32768, - "kindString": "Parameter", - "name": "status", - "type": { - "name": "ActorJobStatus | list[ActorJobStatus] | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorJobStatus", - "target": "1794" - }, - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "ActorJobStatus", - "target": "1794" - } - ], - "target": "2199" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only return runs started before this date (inclusive)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3927, - "kind": 32768, - "kindString": "Parameter", - "name": "started_before", - "type": { - "name": "str | datetime | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "datetime" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only return runs started after this date (inclusive)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3928, - "kind": 32768, - "kindString": "Parameter", - "name": "started_after", - "type": { - "name": "str | datetime | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "datetime" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3929, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfRuns", - "type": "reference", - "target": "768" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over all Actor runs.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3930, - "module": "_resource_clients.run_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over all Actor runs.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n", - "args": { - "limit": "How many runs to retrieve.", - "offset": "What run to include as first when retrieving the list.", - "desc": "Whether to sort the runs in descending order based on their start date.", - "status": "Retrieve only runs with the provided statuses.", - "started_before": "Only return runs started before this date (inclusive).", - "started_after": "Only return runs started after this date (inclusive).", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 82 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over all Actor runs.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n" - } - ] - }, - "flags": {}, - "id": 3931, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many runs to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3932, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What run to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3933, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the runs in descending order based on their start date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3934, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve only runs with the provided statuses." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3935, - "kind": 32768, - "kindString": "Parameter", - "name": "status", - "type": { - "name": "ActorJobStatus | list[ActorJobStatus] | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorJobStatus", - "target": "1794" - }, - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "ActorJobStatus", - "target": "1794" - } - ], - "target": "2199" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only return runs started before this date (inclusive)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3936, - "kind": 32768, - "kindString": "Parameter", - "name": "started_before", - "type": { - "name": "str | datetime | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "datetime" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only return runs started after this date (inclusive)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3937, - "kind": 32768, - "kindString": "Parameter", - "name": "started_after", - "type": { - "name": "str | datetime | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "datetime" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3938, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "Iterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "RunShort", - "target": "1010" - } - ] - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 4017, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the Actor run collection.\n\nProvides methods to manage Actor runs, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClient` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3917, - 3930, - 3921 - ], - "title": "Methods" - }, - { - "children": [ - 4017 - ], - "title": "Properties" - } - ], - "id": 3916, - "module": "_resource_clients.run_collection", - "name": "RunCollectionClient", - "parsedDocstring": { - "text": "Sub-client for the Actor run collection.\n\nProvides methods to manage Actor runs, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClient` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 20 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClient", - "target": "3384", - "type": "reference" - } - ] - }, - { - "kind": 128, - "kindString": "Class", - "children": [ - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3940, - "module": "_resource_clients._resource_client", - "name": "__init__", - "parsedDocstring": { - "text": "Initialize the resource client.\n", - "args": { - "base_url": "API base URL.", - "public_base_url": "Public CDN base URL.", - "http_client": "HTTP client for making requests.", - "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", - "client_registry": "Bundle of client classes for dependency injection.", - "resource_id": "Optional resource ID for single-resource clients.", - "params": "Optional default parameters for all requests." - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 136 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Initialize the resource client.\n" - } - ] - }, - "flags": {}, - "id": 3396, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "__init__", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "API base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3397, - "kind": 32768, - "kindString": "Parameter", - "name": "base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Public CDN base URL." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3398, - "kind": 32768, - "kindString": "Parameter", - "name": "public_base_url", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP client for making requests." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3399, - "kind": 32768, - "kindString": "Parameter", - "name": "http_client", - "type": { - "name": "HttpClientAsync", - "type": "reference", - "target": "1847" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource endpoint path (e.g., 'actors', 'datasets')." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3400, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_path", - "type": { - "name": "str", - "type": "reference" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Bundle of client classes for dependency injection." - } - ] - }, - "flags": { - "isOptional": false, - "keyword-only": true - }, - "id": 3401, - "kind": 32768, - "kindString": "Parameter", - "name": "client_registry", - "type": { - "name": "ClientRegistryAsync", - "type": "reference", - "target": "1738" - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional resource ID for single-resource clients." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3402, - "kind": 32768, - "kindString": "Parameter", - "name": "resource_id", - "type": { - "name": "str | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional default parameters for all requests." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3403, - "kind": 32768, - "kindString": "Parameter", - "name": "params", - "type": { - "name": "dict | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "dict" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "type": { - "name": "None", - "type": "literal", - "value": null - }, - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - } - ], - "overwrites": { - "name": "ResourceClientAsync.__init__", - "target": 3395, - "type": "reference" - } - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3944, - "module": "_resource_clients.run_collection", - "name": "list", - "parsedDocstring": { - "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n", - "args": { - "limit": "How many runs to retrieve.", - "offset": "What run to include as first when retrieving the list.", - "desc": "Whether to sort the runs in descending order based on their start date.", - "status": "Retrieve only runs with the provided statuses.", - "started_before": "Only return runs started before this date (inclusive).", - "started_after": "Only return runs started after this date (inclusive).", - "timeout": "Timeout for the API HTTP request.\n" - }, - "returns": "The retrieved Actor runs." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 147 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "blockTags": [ - { - "content": [ - { - "kind": "text", - "text": "The retrieved Actor runs." - } - ], - "tag": "@returns" - } - ], - "summary": [ - { - "kind": "text", - "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n" - } - ] - }, - "flags": {}, - "id": 3945, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [ - "async" - ], - "name": "list", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many runs to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3946, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What run to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3947, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the runs in descending order based on their start date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3948, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve only runs with the provided statuses." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3949, - "kind": 32768, - "kindString": "Parameter", - "name": "status", - "type": { - "name": "ActorJobStatus | list[ActorJobStatus] | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorJobStatus", - "target": "1794" - }, - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "ActorJobStatus", - "target": "1794" - } - ], - "target": "2199" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only return runs started before this date (inclusive)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3950, - "kind": 32768, - "kindString": "Parameter", - "name": "started_before", - "type": { - "name": "str | datetime | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "datetime" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only return runs started after this date (inclusive)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3951, - "kind": 32768, - "kindString": "Parameter", - "name": "started_after", - "type": { - "name": "str | datetime | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "datetime" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3952, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "ListOfRuns", - "type": "reference", - "target": "768" - } - } - ] - }, - { - "kind": 2048, - "kindString": "Method", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over all Actor runs.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n" - } - ] - }, - "decorations": [], - "flags": {}, - "groups": [], - "id": 3953, - "module": "_resource_clients.run_collection", - "name": "iterate", - "parsedDocstring": { - "text": "Iterate over all Actor runs.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n", - "args": { - "limit": "How many runs to retrieve.", - "offset": "What run to include as first when retrieving the list.", - "desc": "Whether to sort the runs in descending order based on their start date.", - "status": "Retrieve only runs with the provided statuses.", - "started_before": "Only return runs started before this date (inclusive).", - "started_after": "Only return runs started after this date (inclusive).", - "timeout": "Timeout for the API HTTP request.\n" - } - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 191 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "signatures": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Iterate over all Actor runs.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n" - } - ] - }, - "flags": {}, - "id": 3954, - "kind": 4096, - "kindString": "Call signature", - "modifiers": [], - "name": "iterate", - "parameters": [ - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "How many runs to retrieve." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3955, - "kind": 32768, - "kindString": "Parameter", - "name": "limit", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "What run to include as first when retrieving the list." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3956, - "kind": 32768, - "kindString": "Parameter", - "name": "offset", - "type": { - "name": "int | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "int" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to sort the runs in descending order based on their start date." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3957, - "kind": 32768, - "kindString": "Parameter", - "name": "desc", - "type": { - "name": "bool | None", - "type": "union", - "types": [ - { - "type": "reference", - "name": "bool" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve only runs with the provided statuses." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3958, - "kind": 32768, - "kindString": "Parameter", - "name": "status", - "type": { - "name": "ActorJobStatus | list[ActorJobStatus] | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "ActorJobStatus", - "target": "1794" - }, - { - "type": "reference", - "name": "list", - "typeArguments": [ - { - "type": "reference", - "name": "ActorJobStatus", - "target": "1794" - } - ], - "target": "2199" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only return runs started before this date (inclusive)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3959, - "kind": 32768, - "kindString": "Parameter", - "name": "started_before", - "type": { - "name": "str | datetime | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "datetime" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Only return runs started after this date (inclusive)." - } - ] - }, - "defaultValue": "None", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3960, - "kind": 32768, - "kindString": "Parameter", - "name": "started_after", - "type": { - "name": "str | datetime | None", - "type": "union", - "types": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "name": "str" - }, - { - "type": "reference", - "name": "datetime" - } - ] - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the API HTTP request.\n" - } - ] - }, - "defaultValue": "'medium'", - "flags": { - "isOptional": true, - "keyword-only": true - }, - "id": 3961, - "kind": 32768, - "kindString": "Parameter", - "name": "timeout", - "type": { - "name": "Timeout", - "type": "reference", - "target": "13" - } - } - ], - "type": { - "name": "AsyncIterator", - "type": "reference", - "typeArguments": [ - { - "type": "reference", - "name": "RunShort", - "target": "1010" - } - ] - } - } - ] - }, - { - "kind": 1024, - "kindString": "Property", - "children": [], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get the resource ID." - } - ] - }, - "decorations": [ - { - "name": "property" - } - ], - "flags": {}, - "groups": [], - "id": 3990, - "module": "_resource_clients._resource_client", - "name": "resource_id", - "parsedDocstring": { - "text": "Get the resource ID." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/_resource_client.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 72 - } - ], - "type": { - "name": "str | None", - "type": "reference" - }, - "inheritedFrom": { - "name": "ResourceClientBase.resource_id", - "target": 3383, - "type": "reference" - } - } - ], - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sub-client for the Actor run collection.\n\nProvides methods to manage Actor runs, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class." - } - ] - }, - "decorations": [ - { - "args": "('Resource clients')", - "name": "docs_group" - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 3940, - 3953, - 3944 - ], - "title": "Methods" - }, - { - "children": [ - 3990 - ], - "title": "Properties" - } - ], - "id": 3939, - "module": "_resource_clients.run_collection", - "name": "RunCollectionClientAsync", - "parsedDocstring": { - "text": "Sub-client for the Actor run collection.\n\nProvides methods to manage Actor runs, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class." - }, - "sources": [ - { - "character": 1, - "fileName": "/src/apify_client/_resource_clients/run_collection.py", - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74", - "line": 129 - } - ], - "type": { - "name": "Undefined", - "type": "reference" - }, - "extendedTypes": [ - { - "name": "ResourceClientAsync", - "target": "3394", - "type": "reference" - } - ] - } - ], - "flags": {}, - "groups": [ - { - "children": [ - 1436, - 1516 - ], - "title": "Apify API clients" - }, - { - "children": [ - 17, - 16, - 32, - 30, - 28, - 35, - 31, - 33, - 34, - 29 - ], - "title": "Errors" - }, - { - "children": [ - 1836, - 1847, - 1824, - 1805, - 1860, - 1882 - ], - "title": "HTTP clients" - }, - { - "children": [ - 187, - 192, - 215, - 220, - 237, - 240, - 243, - 246, - 255, - 265, - 278, - 275, - 284, - 287, - 291, - 294, - 298, - 306, - 324, - 330, - 333, - 353, - 342, - 347, - 350, - 358, - 365, - 369, - 377, - 393, - 404, - 412, - 424, - 427, - 432, - 451, - 457, - 469, - 488, - 472, - 477, - 480, - 483, - 491, - 537, - 496, - 499, - 507, - 511, - 515, - 522, - 534, - 538, - 541, - 546, - 548, - 551, - 555, - 558, - 562, - 566, - 570, - 575, - 578, - 581, - 588, - 591, - 595, - 611, - 616, - 626, - 619, - 629, - 642, - 753, - 645, - 648, - 756, - 651, - 759, - 654, - 657, - 661, - 667, - 675, - 762, - 664, - 765, - 678, - 681, - 688, - 768, - 691, - 771, - 694, - 774, - 777, - 697, - 700, - 704, - 780, - 707, - 783, - 710, - 713, - 721, - 730, - 736, - 743, - 746, - 786, - 791, - 813, - 818, - 825, - 828, - 831, - 839, - 842, - 846, - 851, - 854, - 857, - 859, - 861, - 876, - 863, - 879, - 893, - 885, - 889, - 895, - 898, - 913, - 919, - 945, - 922, - 938, - 948, - 953, - 956, - 958, - 989, - 992, - 999, - 1007, - 1010, - 1025, - 1044, - 1047, - 1061, - 1115, - 1075, - 1082, - 1088, - 1092, - 1097, - 1102, - 1120, - 1130, - 1136, - 1141, - 1146, - 1149, - 1152, - 1155, - 1158, - 1163, - 1167, - 1172, - 1175, - 1192, - 1197, - 1213, - 1215, - 1223, - 1226, - 1238, - 1241, - 1244, - 1247, - 1250, - 1253, - 1256, - 1274, - 1278, - 1282, - 1286, - 1289, - 1295, - 1296, - 1303, - 1307, - 1314, - 1325, - 1329, - 1336, - 1347, - 1350, - 1368, - 1373, - 1386, - 1396, - 1397, - 1403, - 1406, - 1421, - 1424 - ], - "title": "Models" - }, - { - "children": [ - 2812, - 1693, - 1676, - 44, - 61 - ], - "title": "Other" - }, - { - "children": [ - 3404, - 3506, - 2262, - 2308, - 3758, - 3776, - 2194, - 2211, - 2424, - 2452, - 3275, - 3298, - 3171, - 3195, - 2778, - 2795, - 2819, - 2926, - 3321, - 3347, - 3608, - 3683, - 2372, - 2398, - 2160, - 2177, - 1996, - 2078, - 2480, - 2505, - 3384, - 3394, - 3033, - 3102, - 3916, - 3939, - 1904, - 1930, - 3219, - 3247, - 2598, - 2623, - 2648, - 2713, - 2530, - 2564, - 1956, - 1976, - 3856, - 3886, - 3794, - 3825, - 2354, - 2363, - 2228, - 2245 - ], - "title": "Resource clients" - }, - { - "children": [ - 90, - 78, - 104, - 102, - 111, - 119, - 116, - 125, - 122, - 106, - 138, - 134, - 154, - 142, - 171, - 166 - ], - "title": "Typed dicts" - } - ], - "id": 0, - "kind": 1, - "kindString": "Project", - "name": "apify-client", - "sources": [ - { - "character": 0, - "fileName": "src/index.ts", - "line": 1, - "gitRevision": "80a597410cba2124c5667de8c29cc14ba1bfca74" - } - ], - "symbolIdMap": { - "1": { - "qualifiedName": "ClientStatistics", - "sourceFileName": "/src/apify_client/_statistics.py" - }, - "2": { - "qualifiedName": "calls", - "sourceFileName": "/src/apify_client/_statistics.py" - }, - "3": { - "qualifiedName": "requests", - "sourceFileName": "/src/apify_client/_statistics.py" - }, - "4": { - "qualifiedName": "rate_limit_errors", - "sourceFileName": "/src/apify_client/_statistics.py" - }, - "5": { - "qualifiedName": "add_rate_limit_error", - "sourceFileName": "/src/apify_client/_statistics.py" - }, - "8": { - "qualifiedName": "GroupName", - "sourceFileName": "/src/apify_client/_docs.py" - }, - "9": { - "qualifiedName": "T", - "sourceFileName": "/src/apify_client/_docs.py" - }, - "10": { - "qualifiedName": "docs_group", - "sourceFileName": "/src/apify_client/_docs.py" - }, - "13": { - "qualifiedName": "Timeout", - "sourceFileName": "/src/apify_client/types.py" - }, - "14": { - "qualifiedName": "WebhooksList", - "sourceFileName": "/src/apify_client/types.py" - }, - "15": { - "qualifiedName": "JsonSerializable", - "sourceFileName": "/src/apify_client/types.py" - }, - "16": { - "qualifiedName": "ApifyClientError", - "sourceFileName": "/src/apify_client/errors.py" - }, - "17": { - "qualifiedName": "ApifyApiError", - "sourceFileName": "/src/apify_client/errors.py" - }, - "18": { - "qualifiedName": "__new__", - "sourceFileName": "/src/apify_client/errors.py" - }, - "23": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/errors.py" - }, - "28": { - "qualifiedName": "InvalidRequestError", - "sourceFileName": "/src/apify_client/errors.py" - }, - "29": { - "qualifiedName": "UnauthorizedError", - "sourceFileName": "/src/apify_client/errors.py" - }, - "30": { - "qualifiedName": "ForbiddenError", - "sourceFileName": "/src/apify_client/errors.py" - }, - "31": { - "qualifiedName": "NotFoundError", - "sourceFileName": "/src/apify_client/errors.py" - }, - "32": { - "qualifiedName": "ConflictError", - "sourceFileName": "/src/apify_client/errors.py" - }, - "33": { - "qualifiedName": "RateLimitError", - "sourceFileName": "/src/apify_client/errors.py" - }, - "34": { - "qualifiedName": "ServerError", - "sourceFileName": "/src/apify_client/errors.py" - }, - "35": { - "qualifiedName": "InvalidResponseBodyError", - "sourceFileName": "/src/apify_client/errors.py" - }, - "36": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/errors.py" - }, - "39": { - "qualifiedName": "StreamedLogBase", - "sourceFileName": "/src/apify_client/_streamed_log.py" - }, - "40": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_streamed_log.py" - }, - "44": { - "qualifiedName": "StreamedLog", - "sourceFileName": "/src/apify_client/_streamed_log.py" - }, - "45": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_streamed_log.py" - }, - "50": { - "qualifiedName": "start", - "sourceFileName": "/src/apify_client/_streamed_log.py" - }, - "52": { - "qualifiedName": "stop", - "sourceFileName": "/src/apify_client/_streamed_log.py" - }, - "54": { - "qualifiedName": "__enter__", - "sourceFileName": "/src/apify_client/_streamed_log.py" - }, - "56": { - "qualifiedName": "__exit__", - "sourceFileName": "/src/apify_client/_streamed_log.py" - }, - "61": { - "qualifiedName": "StreamedLogAsync", - "sourceFileName": "/src/apify_client/_streamed_log.py" - }, - "62": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_streamed_log.py" - }, - "67": { - "qualifiedName": "start", - "sourceFileName": "/src/apify_client/_streamed_log.py" - }, - "69": { - "qualifiedName": "stop", - "sourceFileName": "/src/apify_client/_streamed_log.py" - }, - "71": { - "qualifiedName": "__aenter__", - "sourceFileName": "/src/apify_client/_streamed_log.py" - }, - "73": { - "qualifiedName": "__aexit__", - "sourceFileName": "/src/apify_client/_streamed_log.py" - }, - "78": { - "qualifiedName": "RequestBaseDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "79": { - "qualifiedName": "unique_key", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "80": { - "qualifiedName": "url", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "81": { - "qualifiedName": "method", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "82": { - "qualifiedName": "retry_count", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "83": { - "qualifiedName": "loaded_url", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "84": { - "qualifiedName": "payload", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "85": { - "qualifiedName": "headers", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "86": { - "qualifiedName": "user_data", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "87": { - "qualifiedName": "no_retry", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "88": { - "qualifiedName": "error_messages", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "89": { - "qualifiedName": "handled_at", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "90": { - "qualifiedName": "RequestBaseCamelDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "91": { - "qualifiedName": "uniqueKey", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "92": { - "qualifiedName": "url", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "93": { - "qualifiedName": "method", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "94": { - "qualifiedName": "retryCount", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "95": { - "qualifiedName": "loadedUrl", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "96": { - "qualifiedName": "payload", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "97": { - "qualifiedName": "headers", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "98": { - "qualifiedName": "userData", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "99": { - "qualifiedName": "noRetry", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "100": { - "qualifiedName": "errorMessages", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "101": { - "qualifiedName": "handledAt", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "102": { - "qualifiedName": "RequestDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "103": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "104": { - "qualifiedName": "RequestCamelDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "105": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "106": { - "qualifiedName": "RequestDraftDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "107": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "108": { - "qualifiedName": "unique_key", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "109": { - "qualifiedName": "url", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "110": { - "qualifiedName": "method", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "111": { - "qualifiedName": "RequestDraftCamelDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "112": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "113": { - "qualifiedName": "uniqueKey", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "114": { - "qualifiedName": "url", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "115": { - "qualifiedName": "method", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "116": { - "qualifiedName": "RequestDraftDeleteByIdDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "117": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "118": { - "qualifiedName": "unique_key", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "119": { - "qualifiedName": "RequestDraftDeleteByIdCamelDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "120": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "121": { - "qualifiedName": "uniqueKey", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "122": { - "qualifiedName": "RequestDraftDeleteByUniqueKeyDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "123": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "124": { - "qualifiedName": "unique_key", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "125": { - "qualifiedName": "RequestDraftDeleteByUniqueKeyCamelDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "126": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "127": { - "qualifiedName": "uniqueKey", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "128": { - "qualifiedName": "RequestDraftDeleteDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "129": { - "qualifiedName": "RequestDraftDeleteCamelDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "130": { - "qualifiedName": "RequestUserDataDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "131": { - "qualifiedName": "RequestUserDataCamelDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "132": { - "qualifiedName": "TaskInputDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "133": { - "qualifiedName": "TaskInputCamelDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "134": { - "qualifiedName": "WebhookConditionDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "135": { - "qualifiedName": "actor_id", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "136": { - "qualifiedName": "actor_task_id", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "137": { - "qualifiedName": "actor_run_id", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "138": { - "qualifiedName": "WebhookConditionCamelDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "139": { - "qualifiedName": "actorId", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "140": { - "qualifiedName": "actorTaskId", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "141": { - "qualifiedName": "actorRunId", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "142": { - "qualifiedName": "WebhookCreateDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "143": { - "qualifiedName": "is_ad_hoc", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "144": { - "qualifiedName": "event_types", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "145": { - "qualifiedName": "condition", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "146": { - "qualifiedName": "idempotency_key", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "147": { - "qualifiedName": "ignore_ssl_errors", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "148": { - "qualifiedName": "do_not_retry", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "149": { - "qualifiedName": "request_url", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "150": { - "qualifiedName": "payload_template", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "151": { - "qualifiedName": "headers_template", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "152": { - "qualifiedName": "description", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "153": { - "qualifiedName": "should_interpolate_strings", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "154": { - "qualifiedName": "WebhookCreateCamelDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "155": { - "qualifiedName": "isAdHoc", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "156": { - "qualifiedName": "eventTypes", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "157": { - "qualifiedName": "condition", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "158": { - "qualifiedName": "idempotencyKey", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "159": { - "qualifiedName": "ignoreSslErrors", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "160": { - "qualifiedName": "doNotRetry", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "161": { - "qualifiedName": "requestUrl", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "162": { - "qualifiedName": "payloadTemplate", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "163": { - "qualifiedName": "headersTemplate", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "164": { - "qualifiedName": "description", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "165": { - "qualifiedName": "shouldInterpolateStrings", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "166": { - "qualifiedName": "WebhookRepresentationDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "167": { - "qualifiedName": "event_types", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "168": { - "qualifiedName": "request_url", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "169": { - "qualifiedName": "payload_template", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "170": { - "qualifiedName": "headers_template", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "171": { - "qualifiedName": "WebhookRepresentationCamelDict", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "172": { - "qualifiedName": "eventTypes", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "173": { - "qualifiedName": "requestUrl", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "174": { - "qualifiedName": "payloadTemplate", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "175": { - "qualifiedName": "headersTemplate", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "176": { - "qualifiedName": "DEFAULT_API_URL", - "sourceFileName": "/src/apify_client/_consts.py" - }, - "177": { - "qualifiedName": "API_VERSION", - "sourceFileName": "/src/apify_client/_consts.py" - }, - "178": { - "qualifiedName": "DEFAULT_TIMEOUT_SHORT", - "sourceFileName": "/src/apify_client/_consts.py" - }, - "179": { - "qualifiedName": "DEFAULT_TIMEOUT_MEDIUM", - "sourceFileName": "/src/apify_client/_consts.py" - }, - "180": { - "qualifiedName": "DEFAULT_TIMEOUT_LONG", - "sourceFileName": "/src/apify_client/_consts.py" - }, - "181": { - "qualifiedName": "DEFAULT_TIMEOUT_MAX", - "sourceFileName": "/src/apify_client/_consts.py" - }, - "182": { - "qualifiedName": "DEFAULT_MAX_RETRIES", - "sourceFileName": "/src/apify_client/_consts.py" - }, - "183": { - "qualifiedName": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES", - "sourceFileName": "/src/apify_client/_consts.py" - }, - "184": { - "qualifiedName": "DEFAULT_WAIT_FOR_FINISH", - "sourceFileName": "/src/apify_client/_consts.py" - }, - "185": { - "qualifiedName": "DEFAULT_WAIT_WHEN_JOB_NOT_EXIST", - "sourceFileName": "/src/apify_client/_consts.py" - }, - "186": { - "qualifiedName": "OVERRIDABLE_DEFAULT_HEADERS", - "sourceFileName": "/src/apify_client/_consts.py" - }, - "187": { - "qualifiedName": "AccountLimits", - "sourceFileName": "/src/apify_client/_models.py" - }, - "188": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "189": { - "qualifiedName": "monthly_usage_cycle", - "sourceFileName": "/src/apify_client/_models.py" - }, - "190": { - "qualifiedName": "limits", - "sourceFileName": "/src/apify_client/_models.py" - }, - "191": { - "qualifiedName": "current", - "sourceFileName": "/src/apify_client/_models.py" - }, - "192": { - "qualifiedName": "Actor", - "sourceFileName": "/src/apify_client/_models.py" - }, - "193": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "194": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "195": { - "qualifiedName": "user_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "196": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "197": { - "qualifiedName": "username", - "sourceFileName": "/src/apify_client/_models.py" - }, - "198": { - "qualifiedName": "description", - "sourceFileName": "/src/apify_client/_models.py" - }, - "199": { - "qualifiedName": "restart_on_error", - "sourceFileName": "/src/apify_client/_models.py" - }, - "200": { - "qualifiedName": "is_public", - "sourceFileName": "/src/apify_client/_models.py" - }, - "201": { - "qualifiedName": "actor_permission_level", - "sourceFileName": "/src/apify_client/_models.py" - }, - "202": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "203": { - "qualifiedName": "modified_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "204": { - "qualifiedName": "stats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "205": { - "qualifiedName": "versions", - "sourceFileName": "/src/apify_client/_models.py" - }, - "206": { - "qualifiedName": "pricing_infos", - "sourceFileName": "/src/apify_client/_models.py" - }, - "207": { - "qualifiedName": "default_run_options", - "sourceFileName": "/src/apify_client/_models.py" - }, - "208": { - "qualifiedName": "example_run_input", - "sourceFileName": "/src/apify_client/_models.py" - }, - "209": { - "qualifiedName": "is_deprecated", - "sourceFileName": "/src/apify_client/_models.py" - }, - "210": { - "qualifiedName": "deployment_key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "211": { - "qualifiedName": "title", - "sourceFileName": "/src/apify_client/_models.py" - }, - "212": { - "qualifiedName": "tagged_builds", - "sourceFileName": "/src/apify_client/_models.py" - }, - "213": { - "qualifiedName": "actor_standby", - "sourceFileName": "/src/apify_client/_models.py" - }, - "214": { - "qualifiedName": "readme_summary", - "sourceFileName": "/src/apify_client/_models.py" - }, - "215": { - "qualifiedName": "ActorChargeEvent", - "sourceFileName": "/src/apify_client/_models.py" - }, - "216": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "217": { - "qualifiedName": "event_price_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "218": { - "qualifiedName": "event_title", - "sourceFileName": "/src/apify_client/_models.py" - }, - "219": { - "qualifiedName": "event_description", - "sourceFileName": "/src/apify_client/_models.py" - }, - "220": { - "qualifiedName": "ActorDefinition", - "sourceFileName": "/src/apify_client/_models.py" - }, - "221": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "222": { - "qualifiedName": "actor_specification", - "sourceFileName": "/src/apify_client/_models.py" - }, - "223": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "224": { - "qualifiedName": "version", - "sourceFileName": "/src/apify_client/_models.py" - }, - "225": { - "qualifiedName": "build_tag", - "sourceFileName": "/src/apify_client/_models.py" - }, - "226": { - "qualifiedName": "environment_variables", - "sourceFileName": "/src/apify_client/_models.py" - }, - "227": { - "qualifiedName": "dockerfile", - "sourceFileName": "/src/apify_client/_models.py" - }, - "228": { - "qualifiedName": "docker_context_dir", - "sourceFileName": "/src/apify_client/_models.py" - }, - "229": { - "qualifiedName": "readme", - "sourceFileName": "/src/apify_client/_models.py" - }, - "230": { - "qualifiedName": "input", - "sourceFileName": "/src/apify_client/_models.py" - }, - "231": { - "qualifiedName": "changelog", - "sourceFileName": "/src/apify_client/_models.py" - }, - "232": { - "qualifiedName": "storages", - "sourceFileName": "/src/apify_client/_models.py" - }, - "233": { - "qualifiedName": "default_memory_mbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "234": { - "qualifiedName": "min_memory_mbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "235": { - "qualifiedName": "max_memory_mbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "236": { - "qualifiedName": "uses_standby_mode", - "sourceFileName": "/src/apify_client/_models.py" - }, - "237": { - "qualifiedName": "ActorResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "238": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "239": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "240": { - "qualifiedName": "ActorRunFailedError", - "sourceFileName": "/src/apify_client/_models.py" - }, - "241": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "242": { - "qualifiedName": "error", - "sourceFileName": "/src/apify_client/_models.py" - }, - "243": { - "qualifiedName": "ActorRunTimeoutExceededError", - "sourceFileName": "/src/apify_client/_models.py" - }, - "244": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "245": { - "qualifiedName": "error", - "sourceFileName": "/src/apify_client/_models.py" - }, - "246": { - "qualifiedName": "ActorShort", - "sourceFileName": "/src/apify_client/_models.py" - }, - "247": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "248": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "249": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "250": { - "qualifiedName": "modified_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "251": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "252": { - "qualifiedName": "username", - "sourceFileName": "/src/apify_client/_models.py" - }, - "253": { - "qualifiedName": "title", - "sourceFileName": "/src/apify_client/_models.py" - }, - "254": { - "qualifiedName": "stats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "255": { - "qualifiedName": "ActorStandby", - "sourceFileName": "/src/apify_client/_models.py" - }, - "256": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "257": { - "qualifiedName": "is_enabled", - "sourceFileName": "/src/apify_client/_models.py" - }, - "258": { - "qualifiedName": "desired_requests_per_actor_run", - "sourceFileName": "/src/apify_client/_models.py" - }, - "259": { - "qualifiedName": "max_requests_per_actor_run", - "sourceFileName": "/src/apify_client/_models.py" - }, - "260": { - "qualifiedName": "idle_timeout_secs", - "sourceFileName": "/src/apify_client/_models.py" - }, - "261": { - "qualifiedName": "build", - "sourceFileName": "/src/apify_client/_models.py" - }, - "262": { - "qualifiedName": "memory_mbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "263": { - "qualifiedName": "disable_standby_fields_override", - "sourceFileName": "/src/apify_client/_models.py" - }, - "264": { - "qualifiedName": "should_pass_actor_input", - "sourceFileName": "/src/apify_client/_models.py" - }, - "265": { - "qualifiedName": "ActorStats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "266": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "267": { - "qualifiedName": "total_builds", - "sourceFileName": "/src/apify_client/_models.py" - }, - "268": { - "qualifiedName": "total_runs", - "sourceFileName": "/src/apify_client/_models.py" - }, - "269": { - "qualifiedName": "total_users", - "sourceFileName": "/src/apify_client/_models.py" - }, - "270": { - "qualifiedName": "total_users7_days", - "sourceFileName": "/src/apify_client/_models.py" - }, - "271": { - "qualifiedName": "total_users30_days", - "sourceFileName": "/src/apify_client/_models.py" - }, - "272": { - "qualifiedName": "total_users90_days", - "sourceFileName": "/src/apify_client/_models.py" - }, - "273": { - "qualifiedName": "total_metamorphs", - "sourceFileName": "/src/apify_client/_models.py" - }, - "274": { - "qualifiedName": "last_run_started_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "275": { - "qualifiedName": "AddRequestResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "276": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "277": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "278": { - "qualifiedName": "AddedRequest", - "sourceFileName": "/src/apify_client/_models.py" - }, - "279": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "280": { - "qualifiedName": "request_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "281": { - "qualifiedName": "unique_key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "282": { - "qualifiedName": "was_already_present", - "sourceFileName": "/src/apify_client/_models.py" - }, - "283": { - "qualifiedName": "was_already_handled", - "sourceFileName": "/src/apify_client/_models.py" - }, - "284": { - "qualifiedName": "BatchAddResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "285": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "286": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "287": { - "qualifiedName": "BatchAddResult", - "sourceFileName": "/src/apify_client/_models.py" - }, - "288": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "289": { - "qualifiedName": "processed_requests", - "sourceFileName": "/src/apify_client/_models.py" - }, - "290": { - "qualifiedName": "unprocessed_requests", - "sourceFileName": "/src/apify_client/_models.py" - }, - "291": { - "qualifiedName": "BatchDeleteResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "292": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "293": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "294": { - "qualifiedName": "BatchDeleteResult", - "sourceFileName": "/src/apify_client/_models.py" - }, - "295": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "296": { - "qualifiedName": "processed_requests", - "sourceFileName": "/src/apify_client/_models.py" - }, - "297": { - "qualifiedName": "unprocessed_requests", - "sourceFileName": "/src/apify_client/_models.py" - }, - "298": { - "qualifiedName": "BrowserInfoResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "299": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "300": { - "qualifiedName": "method", - "sourceFileName": "/src/apify_client/_models.py" - }, - "301": { - "qualifiedName": "client_ip", - "sourceFileName": "/src/apify_client/_models.py" - }, - "302": { - "qualifiedName": "country_code", - "sourceFileName": "/src/apify_client/_models.py" - }, - "303": { - "qualifiedName": "body_length", - "sourceFileName": "/src/apify_client/_models.py" - }, - "304": { - "qualifiedName": "headers", - "sourceFileName": "/src/apify_client/_models.py" - }, - "305": { - "qualifiedName": "raw_headers", - "sourceFileName": "/src/apify_client/_models.py" - }, - "306": { - "qualifiedName": "Build", - "sourceFileName": "/src/apify_client/_models.py" - }, - "307": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "308": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "309": { - "qualifiedName": "act_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "310": { - "qualifiedName": "user_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "311": { - "qualifiedName": "started_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "312": { - "qualifiedName": "finished_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "313": { - "qualifiedName": "status", - "sourceFileName": "/src/apify_client/_models.py" - }, - "314": { - "qualifiedName": "meta", - "sourceFileName": "/src/apify_client/_models.py" - }, - "315": { - "qualifiedName": "stats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "316": { - "qualifiedName": "options", - "sourceFileName": "/src/apify_client/_models.py" - }, - "317": { - "qualifiedName": "usage", - "sourceFileName": "/src/apify_client/_models.py" - }, - "318": { - "qualifiedName": "usage_total_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "319": { - "qualifiedName": "usage_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "320": { - "qualifiedName": "input_schema", - "sourceFileName": "/src/apify_client/_models.py" - }, - "321": { - "qualifiedName": "readme", - "sourceFileName": "/src/apify_client/_models.py" - }, - "322": { - "qualifiedName": "build_number", - "sourceFileName": "/src/apify_client/_models.py" - }, - "323": { - "qualifiedName": "actor_definition", - "sourceFileName": "/src/apify_client/_models.py" - }, - "324": { - "qualifiedName": "BuildOptions", - "sourceFileName": "/src/apify_client/_models.py" - }, - "325": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "326": { - "qualifiedName": "use_cache", - "sourceFileName": "/src/apify_client/_models.py" - }, - "327": { - "qualifiedName": "beta_packages", - "sourceFileName": "/src/apify_client/_models.py" - }, - "328": { - "qualifiedName": "memory_mbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "329": { - "qualifiedName": "disk_mbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "330": { - "qualifiedName": "BuildResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "331": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "332": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "333": { - "qualifiedName": "BuildShort", - "sourceFileName": "/src/apify_client/_models.py" - }, - "334": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "335": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "336": { - "qualifiedName": "act_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "337": { - "qualifiedName": "status", - "sourceFileName": "/src/apify_client/_models.py" - }, - "338": { - "qualifiedName": "started_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "339": { - "qualifiedName": "finished_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "340": { - "qualifiedName": "usage_total_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "341": { - "qualifiedName": "meta", - "sourceFileName": "/src/apify_client/_models.py" - }, - "342": { - "qualifiedName": "BuildStats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "343": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "344": { - "qualifiedName": "duration_millis", - "sourceFileName": "/src/apify_client/_models.py" - }, - "345": { - "qualifiedName": "run_time_secs", - "sourceFileName": "/src/apify_client/_models.py" - }, - "346": { - "qualifiedName": "compute_units", - "sourceFileName": "/src/apify_client/_models.py" - }, - "347": { - "qualifiedName": "BuildTag", - "sourceFileName": "/src/apify_client/_models.py" - }, - "348": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "349": { - "qualifiedName": "build_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "350": { - "qualifiedName": "BuildUsage", - "sourceFileName": "/src/apify_client/_models.py" - }, - "351": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "352": { - "qualifiedName": "actor_compute_units", - "sourceFileName": "/src/apify_client/_models.py" - }, - "353": { - "qualifiedName": "BuildsMeta", - "sourceFileName": "/src/apify_client/_models.py" - }, - "354": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "355": { - "qualifiedName": "origin", - "sourceFileName": "/src/apify_client/_models.py" - }, - "356": { - "qualifiedName": "client_ip", - "sourceFileName": "/src/apify_client/_models.py" - }, - "357": { - "qualifiedName": "user_agent", - "sourceFileName": "/src/apify_client/_models.py" - }, - "358": { - "qualifiedName": "Call", - "sourceFileName": "/src/apify_client/_models.py" - }, - "359": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "360": { - "qualifiedName": "started_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "361": { - "qualifiedName": "finished_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "362": { - "qualifiedName": "error_message", - "sourceFileName": "/src/apify_client/_models.py" - }, - "363": { - "qualifiedName": "response_status", - "sourceFileName": "/src/apify_client/_models.py" - }, - "364": { - "qualifiedName": "response_body", - "sourceFileName": "/src/apify_client/_models.py" - }, - "365": { - "qualifiedName": "ChargeRunRequest", - "sourceFileName": "/src/apify_client/_models.py" - }, - "366": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "367": { - "qualifiedName": "event_name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "368": { - "qualifiedName": "count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "369": { - "qualifiedName": "CommonActorPricingInfo", - "sourceFileName": "/src/apify_client/_models.py" - }, - "370": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "371": { - "qualifiedName": "apify_margin_percentage", - "sourceFileName": "/src/apify_client/_models.py" - }, - "372": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "373": { - "qualifiedName": "started_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "374": { - "qualifiedName": "notified_about_future_change_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "375": { - "qualifiedName": "notified_about_change_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "376": { - "qualifiedName": "reason_for_change", - "sourceFileName": "/src/apify_client/_models.py" - }, - "377": { - "qualifiedName": "CreateActorRequest", - "sourceFileName": "/src/apify_client/_models.py" - }, - "378": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "379": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "380": { - "qualifiedName": "description", - "sourceFileName": "/src/apify_client/_models.py" - }, - "381": { - "qualifiedName": "title", - "sourceFileName": "/src/apify_client/_models.py" - }, - "382": { - "qualifiedName": "is_public", - "sourceFileName": "/src/apify_client/_models.py" - }, - "383": { - "qualifiedName": "seo_title", - "sourceFileName": "/src/apify_client/_models.py" - }, - "384": { - "qualifiedName": "seo_description", - "sourceFileName": "/src/apify_client/_models.py" - }, - "385": { - "qualifiedName": "restart_on_error", - "sourceFileName": "/src/apify_client/_models.py" - }, - "386": { - "qualifiedName": "versions", - "sourceFileName": "/src/apify_client/_models.py" - }, - "387": { - "qualifiedName": "pricing_infos", - "sourceFileName": "/src/apify_client/_models.py" - }, - "388": { - "qualifiedName": "categories", - "sourceFileName": "/src/apify_client/_models.py" - }, - "389": { - "qualifiedName": "default_run_options", - "sourceFileName": "/src/apify_client/_models.py" - }, - "390": { - "qualifiedName": "actor_standby", - "sourceFileName": "/src/apify_client/_models.py" - }, - "391": { - "qualifiedName": "example_run_input", - "sourceFileName": "/src/apify_client/_models.py" - }, - "392": { - "qualifiedName": "is_deprecated", - "sourceFileName": "/src/apify_client/_models.py" - }, - "393": { - "qualifiedName": "CreateOrUpdateVersionRequest", - "sourceFileName": "/src/apify_client/_models.py" - }, - "394": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "395": { - "qualifiedName": "version_number", - "sourceFileName": "/src/apify_client/_models.py" - }, - "396": { - "qualifiedName": "source_type", - "sourceFileName": "/src/apify_client/_models.py" - }, - "397": { - "qualifiedName": "env_vars", - "sourceFileName": "/src/apify_client/_models.py" - }, - "398": { - "qualifiedName": "apply_env_vars_to_build", - "sourceFileName": "/src/apify_client/_models.py" - }, - "399": { - "qualifiedName": "build_tag", - "sourceFileName": "/src/apify_client/_models.py" - }, - "400": { - "qualifiedName": "source_files", - "sourceFileName": "/src/apify_client/_models.py" - }, - "401": { - "qualifiedName": "git_repo_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "402": { - "qualifiedName": "tarball_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "403": { - "qualifiedName": "github_gist_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "404": { - "qualifiedName": "CreateTaskRequest", - "sourceFileName": "/src/apify_client/_models.py" - }, - "405": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "406": { - "qualifiedName": "act_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "407": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "408": { - "qualifiedName": "options", - "sourceFileName": "/src/apify_client/_models.py" - }, - "409": { - "qualifiedName": "input", - "sourceFileName": "/src/apify_client/_models.py" - }, - "410": { - "qualifiedName": "title", - "sourceFileName": "/src/apify_client/_models.py" - }, - "411": { - "qualifiedName": "actor_standby", - "sourceFileName": "/src/apify_client/_models.py" - }, - "412": { - "qualifiedName": "Current", - "sourceFileName": "/src/apify_client/_models.py" - }, - "413": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "414": { - "qualifiedName": "monthly_usage_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "415": { - "qualifiedName": "monthly_actor_compute_units", - "sourceFileName": "/src/apify_client/_models.py" - }, - "416": { - "qualifiedName": "monthly_external_data_transfer_gbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "417": { - "qualifiedName": "monthly_proxy_serps", - "sourceFileName": "/src/apify_client/_models.py" - }, - "418": { - "qualifiedName": "monthly_residential_proxy_gbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "419": { - "qualifiedName": "actor_memory_gbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "420": { - "qualifiedName": "actor_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "421": { - "qualifiedName": "actor_task_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "422": { - "qualifiedName": "active_actor_job_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "423": { - "qualifiedName": "team_account_seat_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "424": { - "qualifiedName": "CurrentPricingInfo", - "sourceFileName": "/src/apify_client/_models.py" - }, - "425": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "426": { - "qualifiedName": "pricing_model", - "sourceFileName": "/src/apify_client/_models.py" - }, - "427": { - "qualifiedName": "DailyServiceUsages", - "sourceFileName": "/src/apify_client/_models.py" - }, - "428": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "429": { - "qualifiedName": "date", - "sourceFileName": "/src/apify_client/_models.py" - }, - "430": { - "qualifiedName": "service_usage", - "sourceFileName": "/src/apify_client/_models.py" - }, - "431": { - "qualifiedName": "total_usage_credits_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "432": { - "qualifiedName": "Dataset", - "sourceFileName": "/src/apify_client/_models.py" - }, - "433": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "434": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "435": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "436": { - "qualifiedName": "user_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "437": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "438": { - "qualifiedName": "modified_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "439": { - "qualifiedName": "accessed_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "440": { - "qualifiedName": "item_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "441": { - "qualifiedName": "clean_item_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "442": { - "qualifiedName": "act_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "443": { - "qualifiedName": "act_run_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "444": { - "qualifiedName": "fields", - "sourceFileName": "/src/apify_client/_models.py" - }, - "445": { - "qualifiedName": "schema_", - "sourceFileName": "/src/apify_client/_models.py" - }, - "446": { - "qualifiedName": "console_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "447": { - "qualifiedName": "items_public_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "448": { - "qualifiedName": "url_signing_secret_key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "449": { - "qualifiedName": "general_access", - "sourceFileName": "/src/apify_client/_models.py" - }, - "450": { - "qualifiedName": "stats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "451": { - "qualifiedName": "DatasetFieldStatistics", - "sourceFileName": "/src/apify_client/_models.py" - }, - "452": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "453": { - "qualifiedName": "min", - "sourceFileName": "/src/apify_client/_models.py" - }, - "454": { - "qualifiedName": "max", - "sourceFileName": "/src/apify_client/_models.py" - }, - "455": { - "qualifiedName": "null_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "456": { - "qualifiedName": "empty_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "457": { - "qualifiedName": "DatasetListItem", - "sourceFileName": "/src/apify_client/_models.py" - }, - "458": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "459": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "460": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "461": { - "qualifiedName": "user_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "462": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "463": { - "qualifiedName": "modified_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "464": { - "qualifiedName": "accessed_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "465": { - "qualifiedName": "item_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "466": { - "qualifiedName": "clean_item_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "467": { - "qualifiedName": "act_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "468": { - "qualifiedName": "act_run_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "469": { - "qualifiedName": "DatasetResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "470": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "471": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "472": { - "qualifiedName": "DatasetSchemaValidationError", - "sourceFileName": "/src/apify_client/_models.py" - }, - "473": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "474": { - "qualifiedName": "type", - "sourceFileName": "/src/apify_client/_models.py" - }, - "475": { - "qualifiedName": "message", - "sourceFileName": "/src/apify_client/_models.py" - }, - "476": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "477": { - "qualifiedName": "DatasetStatistics", - "sourceFileName": "/src/apify_client/_models.py" - }, - "478": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "479": { - "qualifiedName": "field_statistics", - "sourceFileName": "/src/apify_client/_models.py" - }, - "480": { - "qualifiedName": "DatasetStatisticsResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "481": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "482": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "483": { - "qualifiedName": "DatasetStats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "484": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "485": { - "qualifiedName": "read_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "486": { - "qualifiedName": "write_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "487": { - "qualifiedName": "storage_bytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "488": { - "qualifiedName": "Datasets", - "sourceFileName": "/src/apify_client/_models.py" - }, - "489": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "490": { - "qualifiedName": "default", - "sourceFileName": "/src/apify_client/_models.py" - }, - "491": { - "qualifiedName": "DecodeAndVerifyData", - "sourceFileName": "/src/apify_client/_models.py" - }, - "492": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "493": { - "qualifiedName": "decoded", - "sourceFileName": "/src/apify_client/_models.py" - }, - "494": { - "qualifiedName": "encoded_by_user_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "495": { - "qualifiedName": "is_verified_user", - "sourceFileName": "/src/apify_client/_models.py" - }, - "496": { - "qualifiedName": "DecodeAndVerifyResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "497": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "498": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "499": { - "qualifiedName": "DefaultRunOptions", - "sourceFileName": "/src/apify_client/_models.py" - }, - "500": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "501": { - "qualifiedName": "build", - "sourceFileName": "/src/apify_client/_models.py" - }, - "502": { - "qualifiedName": "timeout_secs", - "sourceFileName": "/src/apify_client/_models.py" - }, - "503": { - "qualifiedName": "memory_mbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "504": { - "qualifiedName": "restart_on_error", - "sourceFileName": "/src/apify_client/_models.py" - }, - "505": { - "qualifiedName": "max_items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "506": { - "qualifiedName": "force_permission_level", - "sourceFileName": "/src/apify_client/_models.py" - }, - "507": { - "qualifiedName": "DeletedRequestById", - "sourceFileName": "/src/apify_client/_models.py" - }, - "508": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "509": { - "qualifiedName": "unique_key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "510": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "511": { - "qualifiedName": "DeletedRequestByUniqueKey", - "sourceFileName": "/src/apify_client/_models.py" - }, - "512": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "513": { - "qualifiedName": "unique_key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "514": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "515": { - "qualifiedName": "EffectivePlatformFeature", - "sourceFileName": "/src/apify_client/_models.py" - }, - "516": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "517": { - "qualifiedName": "is_enabled", - "sourceFileName": "/src/apify_client/_models.py" - }, - "518": { - "qualifiedName": "disabled_reason", - "sourceFileName": "/src/apify_client/_models.py" - }, - "519": { - "qualifiedName": "disabled_reason_type", - "sourceFileName": "/src/apify_client/_models.py" - }, - "520": { - "qualifiedName": "is_trial", - "sourceFileName": "/src/apify_client/_models.py" - }, - "521": { - "qualifiedName": "trial_expiration_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "522": { - "qualifiedName": "EffectivePlatformFeatures", - "sourceFileName": "/src/apify_client/_models.py" - }, - "523": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "524": { - "qualifiedName": "actors", - "sourceFileName": "/src/apify_client/_models.py" - }, - "525": { - "qualifiedName": "storage", - "sourceFileName": "/src/apify_client/_models.py" - }, - "526": { - "qualifiedName": "scheduler", - "sourceFileName": "/src/apify_client/_models.py" - }, - "527": { - "qualifiedName": "proxy", - "sourceFileName": "/src/apify_client/_models.py" - }, - "528": { - "qualifiedName": "proxy_external_access", - "sourceFileName": "/src/apify_client/_models.py" - }, - "529": { - "qualifiedName": "proxy_residential", - "sourceFileName": "/src/apify_client/_models.py" - }, - "530": { - "qualifiedName": "proxy_serps", - "sourceFileName": "/src/apify_client/_models.py" - }, - "531": { - "qualifiedName": "webhooks", - "sourceFileName": "/src/apify_client/_models.py" - }, - "532": { - "qualifiedName": "actors_public_all", - "sourceFileName": "/src/apify_client/_models.py" - }, - "533": { - "qualifiedName": "actors_public_developer", - "sourceFileName": "/src/apify_client/_models.py" - }, - "534": { - "qualifiedName": "EncodeAndSignData", - "sourceFileName": "/src/apify_client/_models.py" - }, - "535": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "536": { - "qualifiedName": "encoded", - "sourceFileName": "/src/apify_client/_models.py" - }, - "537": { - "qualifiedName": "DecodeAndVerifyRequest", - "sourceFileName": "/src/apify_client/_models.py" - }, - "538": { - "qualifiedName": "EncodeAndSignResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "539": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "540": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "541": { - "qualifiedName": "EnvVar", - "sourceFileName": "/src/apify_client/_models.py" - }, - "542": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "543": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "544": { - "qualifiedName": "value", - "sourceFileName": "/src/apify_client/_models.py" - }, - "545": { - "qualifiedName": "is_secret", - "sourceFileName": "/src/apify_client/_models.py" - }, - "546": { - "qualifiedName": "EnvVarRequest", - "sourceFileName": "/src/apify_client/_models.py" - }, - "547": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "548": { - "qualifiedName": "EnvVarResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "549": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "550": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "551": { - "qualifiedName": "ErrorDetail", - "sourceFileName": "/src/apify_client/_models.py" - }, - "552": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "553": { - "qualifiedName": "type", - "sourceFileName": "/src/apify_client/_models.py" - }, - "554": { - "qualifiedName": "message", - "sourceFileName": "/src/apify_client/_models.py" - }, - "555": { - "qualifiedName": "ErrorResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "556": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "557": { - "qualifiedName": "error", - "sourceFileName": "/src/apify_client/_models.py" - }, - "558": { - "qualifiedName": "EventData", - "sourceFileName": "/src/apify_client/_models.py" - }, - "559": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "560": { - "qualifiedName": "actor_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "561": { - "qualifiedName": "actor_run_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "562": { - "qualifiedName": "ExampleRunInput", - "sourceFileName": "/src/apify_client/_models.py" - }, - "563": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "564": { - "qualifiedName": "body", - "sourceFileName": "/src/apify_client/_models.py" - }, - "565": { - "qualifiedName": "content_type", - "sourceFileName": "/src/apify_client/_models.py" - }, - "566": { - "qualifiedName": "ExampleWebhookDispatch", - "sourceFileName": "/src/apify_client/_models.py" - }, - "567": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "568": { - "qualifiedName": "status", - "sourceFileName": "/src/apify_client/_models.py" - }, - "569": { - "qualifiedName": "finished_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "570": { - "qualifiedName": "FlatPricePerMonthActorPricingInfo", - "sourceFileName": "/src/apify_client/_models.py" - }, - "571": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "572": { - "qualifiedName": "pricing_model", - "sourceFileName": "/src/apify_client/_models.py" - }, - "573": { - "qualifiedName": "trial_minutes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "574": { - "qualifiedName": "price_per_unit_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "575": { - "qualifiedName": "FreeActorPricingInfo", - "sourceFileName": "/src/apify_client/_models.py" - }, - "576": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "577": { - "qualifiedName": "pricing_model", - "sourceFileName": "/src/apify_client/_models.py" - }, - "578": { - "qualifiedName": "HeadAndLockResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "579": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "580": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "581": { - "qualifiedName": "HeadRequest", - "sourceFileName": "/src/apify_client/_models.py" - }, - "582": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "583": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "584": { - "qualifiedName": "unique_key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "585": { - "qualifiedName": "url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "586": { - "qualifiedName": "method", - "sourceFileName": "/src/apify_client/_models.py" - }, - "587": { - "qualifiedName": "retry_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "588": { - "qualifiedName": "HeadResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "589": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "590": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "591": { - "qualifiedName": "InvalidItem", - "sourceFileName": "/src/apify_client/_models.py" - }, - "592": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "593": { - "qualifiedName": "item_position", - "sourceFileName": "/src/apify_client/_models.py" - }, - "594": { - "qualifiedName": "validation_errors", - "sourceFileName": "/src/apify_client/_models.py" - }, - "595": { - "qualifiedName": "KeyValueStore", - "sourceFileName": "/src/apify_client/_models.py" - }, - "596": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "597": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "598": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "599": { - "qualifiedName": "user_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "600": { - "qualifiedName": "username", - "sourceFileName": "/src/apify_client/_models.py" - }, - "601": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "602": { - "qualifiedName": "modified_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "603": { - "qualifiedName": "accessed_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "604": { - "qualifiedName": "act_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "605": { - "qualifiedName": "act_run_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "606": { - "qualifiedName": "console_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "607": { - "qualifiedName": "keys_public_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "608": { - "qualifiedName": "url_signing_secret_key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "609": { - "qualifiedName": "general_access", - "sourceFileName": "/src/apify_client/_models.py" - }, - "610": { - "qualifiedName": "stats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "611": { - "qualifiedName": "KeyValueStoreKey", - "sourceFileName": "/src/apify_client/_models.py" - }, - "612": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "613": { - "qualifiedName": "key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "614": { - "qualifiedName": "size", - "sourceFileName": "/src/apify_client/_models.py" - }, - "615": { - "qualifiedName": "record_public_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "616": { - "qualifiedName": "KeyValueStoreResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "617": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "618": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "619": { - "qualifiedName": "KeyValueStoreStats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "620": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "621": { - "qualifiedName": "read_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "622": { - "qualifiedName": "write_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "623": { - "qualifiedName": "delete_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "624": { - "qualifiedName": "list_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "625": { - "qualifiedName": "s3_storage_bytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "626": { - "qualifiedName": "KeyValueStores", - "sourceFileName": "/src/apify_client/_models.py" - }, - "627": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "628": { - "qualifiedName": "default", - "sourceFileName": "/src/apify_client/_models.py" - }, - "629": { - "qualifiedName": "Limits", - "sourceFileName": "/src/apify_client/_models.py" - }, - "630": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "631": { - "qualifiedName": "max_monthly_usage_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "632": { - "qualifiedName": "max_monthly_actor_compute_units", - "sourceFileName": "/src/apify_client/_models.py" - }, - "633": { - "qualifiedName": "max_monthly_external_data_transfer_gbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "634": { - "qualifiedName": "max_monthly_proxy_serps", - "sourceFileName": "/src/apify_client/_models.py" - }, - "635": { - "qualifiedName": "max_monthly_residential_proxy_gbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "636": { - "qualifiedName": "max_actor_memory_gbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "637": { - "qualifiedName": "max_actor_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "638": { - "qualifiedName": "max_actor_task_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "639": { - "qualifiedName": "max_concurrent_actor_jobs", - "sourceFileName": "/src/apify_client/_models.py" - }, - "640": { - "qualifiedName": "max_team_account_seat_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "641": { - "qualifiedName": "data_retention_days", - "sourceFileName": "/src/apify_client/_models.py" - }, - "642": { - "qualifiedName": "LimitsResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "643": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "644": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "645": { - "qualifiedName": "ListOfActorsInStoreResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "646": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "647": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "648": { - "qualifiedName": "ListOfActorsResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "649": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "650": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "651": { - "qualifiedName": "ListOfBuildsResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "652": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "653": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "654": { - "qualifiedName": "ListOfDatasetsResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "655": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "656": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "657": { - "qualifiedName": "ListOfEnvVars", - "sourceFileName": "/src/apify_client/_models.py" - }, - "658": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "659": { - "qualifiedName": "total", - "sourceFileName": "/src/apify_client/_models.py" - }, - "660": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "661": { - "qualifiedName": "ListOfEnvVarsResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "662": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "663": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "664": { - "qualifiedName": "ListOfKeyValueStoresResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "665": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "666": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "667": { - "qualifiedName": "ListOfKeys", - "sourceFileName": "/src/apify_client/_models.py" - }, - "668": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "669": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "670": { - "qualifiedName": "count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "671": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify_client/_models.py" - }, - "672": { - "qualifiedName": "exclusive_start_key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "673": { - "qualifiedName": "is_truncated", - "sourceFileName": "/src/apify_client/_models.py" - }, - "674": { - "qualifiedName": "next_exclusive_start_key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "675": { - "qualifiedName": "ListOfKeysResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "676": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "677": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "678": { - "qualifiedName": "ListOfRequestQueuesResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "679": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "680": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "681": { - "qualifiedName": "ListOfRequests", - "sourceFileName": "/src/apify_client/_models.py" - }, - "682": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "683": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "684": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify_client/_models.py" - }, - "685": { - "qualifiedName": "exclusive_start_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "686": { - "qualifiedName": "cursor", - "sourceFileName": "/src/apify_client/_models.py" - }, - "687": { - "qualifiedName": "next_cursor", - "sourceFileName": "/src/apify_client/_models.py" - }, - "688": { - "qualifiedName": "ListOfRequestsResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "689": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "690": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "691": { - "qualifiedName": "ListOfRunsResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "692": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "693": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "694": { - "qualifiedName": "ListOfSchedulesResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "695": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "696": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "697": { - "qualifiedName": "ListOfTasksResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "698": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "699": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "700": { - "qualifiedName": "ListOfVersions", - "sourceFileName": "/src/apify_client/_models.py" - }, - "701": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "702": { - "qualifiedName": "total", - "sourceFileName": "/src/apify_client/_models.py" - }, - "703": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "704": { - "qualifiedName": "ListOfVersionsResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "705": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "706": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "707": { - "qualifiedName": "ListOfWebhookDispatchesResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "708": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "709": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "710": { - "qualifiedName": "ListOfWebhooksResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "711": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "712": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "713": { - "qualifiedName": "LockedHeadRequest", - "sourceFileName": "/src/apify_client/_models.py" - }, - "714": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "715": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "716": { - "qualifiedName": "unique_key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "717": { - "qualifiedName": "url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "718": { - "qualifiedName": "method", - "sourceFileName": "/src/apify_client/_models.py" - }, - "719": { - "qualifiedName": "retry_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "720": { - "qualifiedName": "lock_expires_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "721": { - "qualifiedName": "LockedRequestQueueHead", - "sourceFileName": "/src/apify_client/_models.py" - }, - "722": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "723": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify_client/_models.py" - }, - "724": { - "qualifiedName": "queue_modified_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "725": { - "qualifiedName": "queue_has_locked_requests", - "sourceFileName": "/src/apify_client/_models.py" - }, - "726": { - "qualifiedName": "client_key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "727": { - "qualifiedName": "had_multiple_clients", - "sourceFileName": "/src/apify_client/_models.py" - }, - "728": { - "qualifiedName": "lock_secs", - "sourceFileName": "/src/apify_client/_models.py" - }, - "729": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "730": { - "qualifiedName": "Metamorph", - "sourceFileName": "/src/apify_client/_models.py" - }, - "731": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "732": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "733": { - "qualifiedName": "actor_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "734": { - "qualifiedName": "build_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "735": { - "qualifiedName": "input_key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "736": { - "qualifiedName": "MonthlyUsage", - "sourceFileName": "/src/apify_client/_models.py" - }, - "737": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "738": { - "qualifiedName": "usage_cycle", - "sourceFileName": "/src/apify_client/_models.py" - }, - "739": { - "qualifiedName": "monthly_service_usage", - "sourceFileName": "/src/apify_client/_models.py" - }, - "740": { - "qualifiedName": "daily_service_usages", - "sourceFileName": "/src/apify_client/_models.py" - }, - "741": { - "qualifiedName": "total_usage_credits_usd_before_volume_discount", - "sourceFileName": "/src/apify_client/_models.py" - }, - "742": { - "qualifiedName": "total_usage_credits_usd_after_volume_discount", - "sourceFileName": "/src/apify_client/_models.py" - }, - "743": { - "qualifiedName": "MonthlyUsageResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "744": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "745": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "746": { - "qualifiedName": "PaginationResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "747": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "748": { - "qualifiedName": "total", - "sourceFileName": "/src/apify_client/_models.py" - }, - "749": { - "qualifiedName": "offset", - "sourceFileName": "/src/apify_client/_models.py" - }, - "750": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify_client/_models.py" - }, - "751": { - "qualifiedName": "desc", - "sourceFileName": "/src/apify_client/_models.py" - }, - "752": { - "qualifiedName": "count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "753": { - "qualifiedName": "ListOfActors", - "sourceFileName": "/src/apify_client/_models.py" - }, - "754": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "755": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "756": { - "qualifiedName": "ListOfBuilds", - "sourceFileName": "/src/apify_client/_models.py" - }, - "757": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "758": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "759": { - "qualifiedName": "ListOfDatasets", - "sourceFileName": "/src/apify_client/_models.py" - }, - "760": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "761": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "762": { - "qualifiedName": "ListOfKeyValueStores", - "sourceFileName": "/src/apify_client/_models.py" - }, - "763": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "764": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "765": { - "qualifiedName": "ListOfRequestQueues", - "sourceFileName": "/src/apify_client/_models.py" - }, - "766": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "767": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "768": { - "qualifiedName": "ListOfRuns", - "sourceFileName": "/src/apify_client/_models.py" - }, - "769": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "770": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "771": { - "qualifiedName": "ListOfSchedules", - "sourceFileName": "/src/apify_client/_models.py" - }, - "772": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "773": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "774": { - "qualifiedName": "ListOfStoreActors", - "sourceFileName": "/src/apify_client/_models.py" - }, - "775": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "776": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "777": { - "qualifiedName": "ListOfTasks", - "sourceFileName": "/src/apify_client/_models.py" - }, - "778": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "779": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "780": { - "qualifiedName": "ListOfWebhookDispatches", - "sourceFileName": "/src/apify_client/_models.py" - }, - "781": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "782": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "783": { - "qualifiedName": "ListOfWebhooks", - "sourceFileName": "/src/apify_client/_models.py" - }, - "784": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "785": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "786": { - "qualifiedName": "PayPerEventActorPricingInfo", - "sourceFileName": "/src/apify_client/_models.py" - }, - "787": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "788": { - "qualifiedName": "pricing_model", - "sourceFileName": "/src/apify_client/_models.py" - }, - "789": { - "qualifiedName": "pricing_per_event", - "sourceFileName": "/src/apify_client/_models.py" - }, - "790": { - "qualifiedName": "minimal_max_total_charge_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "791": { - "qualifiedName": "Plan", - "sourceFileName": "/src/apify_client/_models.py" - }, - "792": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "793": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "794": { - "qualifiedName": "description", - "sourceFileName": "/src/apify_client/_models.py" - }, - "795": { - "qualifiedName": "is_enabled", - "sourceFileName": "/src/apify_client/_models.py" - }, - "796": { - "qualifiedName": "monthly_base_price_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "797": { - "qualifiedName": "monthly_usage_credits_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "798": { - "qualifiedName": "usage_discount_percent", - "sourceFileName": "/src/apify_client/_models.py" - }, - "799": { - "qualifiedName": "enabled_platform_features", - "sourceFileName": "/src/apify_client/_models.py" - }, - "800": { - "qualifiedName": "max_monthly_usage_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "801": { - "qualifiedName": "max_actor_memory_gbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "802": { - "qualifiedName": "max_monthly_actor_compute_units", - "sourceFileName": "/src/apify_client/_models.py" - }, - "803": { - "qualifiedName": "max_monthly_residential_proxy_gbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "804": { - "qualifiedName": "max_monthly_proxy_serps", - "sourceFileName": "/src/apify_client/_models.py" - }, - "805": { - "qualifiedName": "max_monthly_external_data_transfer_gbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "806": { - "qualifiedName": "max_actor_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "807": { - "qualifiedName": "max_actor_task_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "808": { - "qualifiedName": "data_retention_days", - "sourceFileName": "/src/apify_client/_models.py" - }, - "809": { - "qualifiedName": "available_proxy_groups", - "sourceFileName": "/src/apify_client/_models.py" - }, - "810": { - "qualifiedName": "team_account_seat_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "811": { - "qualifiedName": "support_level", - "sourceFileName": "/src/apify_client/_models.py" - }, - "812": { - "qualifiedName": "available_add_ons", - "sourceFileName": "/src/apify_client/_models.py" - }, - "813": { - "qualifiedName": "PricePerDatasetItemActorPricingInfo", - "sourceFileName": "/src/apify_client/_models.py" - }, - "814": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "815": { - "qualifiedName": "pricing_model", - "sourceFileName": "/src/apify_client/_models.py" - }, - "816": { - "qualifiedName": "unit_name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "817": { - "qualifiedName": "price_per_unit_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "818": { - "qualifiedName": "PriceTiers", - "sourceFileName": "/src/apify_client/_models.py" - }, - "819": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "820": { - "qualifiedName": "quantity_above", - "sourceFileName": "/src/apify_client/_models.py" - }, - "821": { - "qualifiedName": "discount_percent", - "sourceFileName": "/src/apify_client/_models.py" - }, - "822": { - "qualifiedName": "tier_quantity", - "sourceFileName": "/src/apify_client/_models.py" - }, - "823": { - "qualifiedName": "unit_price_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "824": { - "qualifiedName": "price_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "825": { - "qualifiedName": "PricingPerEvent", - "sourceFileName": "/src/apify_client/_models.py" - }, - "826": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "827": { - "qualifiedName": "actor_charge_events", - "sourceFileName": "/src/apify_client/_models.py" - }, - "828": { - "qualifiedName": "PrivateUserDataResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "829": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "830": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "831": { - "qualifiedName": "Profile", - "sourceFileName": "/src/apify_client/_models.py" - }, - "832": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "833": { - "qualifiedName": "bio", - "sourceFileName": "/src/apify_client/_models.py" - }, - "834": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "835": { - "qualifiedName": "picture_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "836": { - "qualifiedName": "github_username", - "sourceFileName": "/src/apify_client/_models.py" - }, - "837": { - "qualifiedName": "website_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "838": { - "qualifiedName": "twitter_username", - "sourceFileName": "/src/apify_client/_models.py" - }, - "839": { - "qualifiedName": "ProlongRequestLockResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "840": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "841": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "842": { - "qualifiedName": "Proxy", - "sourceFileName": "/src/apify_client/_models.py" - }, - "843": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "844": { - "qualifiedName": "password", - "sourceFileName": "/src/apify_client/_models.py" - }, - "845": { - "qualifiedName": "groups", - "sourceFileName": "/src/apify_client/_models.py" - }, - "846": { - "qualifiedName": "ProxyGroup", - "sourceFileName": "/src/apify_client/_models.py" - }, - "847": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "848": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "849": { - "qualifiedName": "description", - "sourceFileName": "/src/apify_client/_models.py" - }, - "850": { - "qualifiedName": "available_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "851": { - "qualifiedName": "PublicUserDataResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "852": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "853": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "854": { - "qualifiedName": "PutItemResponseError", - "sourceFileName": "/src/apify_client/_models.py" - }, - "855": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "856": { - "qualifiedName": "error", - "sourceFileName": "/src/apify_client/_models.py" - }, - "857": { - "qualifiedName": "PutItemsRequest", - "sourceFileName": "/src/apify_client/_models.py" - }, - "858": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "859": { - "qualifiedName": "PutRecordRequest", - "sourceFileName": "/src/apify_client/_models.py" - }, - "860": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "861": { - "qualifiedName": "RecordResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "862": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "863": { - "qualifiedName": "RequestBase", - "sourceFileName": "/src/apify_client/_models.py" - }, - "864": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "865": { - "qualifiedName": "unique_key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "866": { - "qualifiedName": "url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "867": { - "qualifiedName": "method", - "sourceFileName": "/src/apify_client/_models.py" - }, - "868": { - "qualifiedName": "retry_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "869": { - "qualifiedName": "loaded_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "870": { - "qualifiedName": "payload", - "sourceFileName": "/src/apify_client/_models.py" - }, - "871": { - "qualifiedName": "headers", - "sourceFileName": "/src/apify_client/_models.py" - }, - "872": { - "qualifiedName": "user_data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "873": { - "qualifiedName": "no_retry", - "sourceFileName": "/src/apify_client/_models.py" - }, - "874": { - "qualifiedName": "error_messages", - "sourceFileName": "/src/apify_client/_models.py" - }, - "875": { - "qualifiedName": "handled_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "876": { - "qualifiedName": "Request", - "sourceFileName": "/src/apify_client/_models.py" - }, - "877": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "878": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "879": { - "qualifiedName": "RequestDraft", - "sourceFileName": "/src/apify_client/_models.py" - }, - "880": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "881": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "882": { - "qualifiedName": "unique_key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "883": { - "qualifiedName": "url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "884": { - "qualifiedName": "method", - "sourceFileName": "/src/apify_client/_models.py" - }, - "885": { - "qualifiedName": "RequestDraftDeleteById", - "sourceFileName": "/src/apify_client/_models.py" - }, - "886": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "887": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "888": { - "qualifiedName": "unique_key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "889": { - "qualifiedName": "RequestDraftDeleteByUniqueKey", - "sourceFileName": "/src/apify_client/_models.py" - }, - "890": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "891": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "892": { - "qualifiedName": "unique_key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "893": { - "qualifiedName": "RequestDraftDelete", - "sourceFileName": "/src/apify_client/_models.py" - }, - "894": { - "qualifiedName": "root", - "sourceFileName": "/src/apify_client/_models.py" - }, - "895": { - "qualifiedName": "RequestLockInfo", - "sourceFileName": "/src/apify_client/_models.py" - }, - "896": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "897": { - "qualifiedName": "lock_expires_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "898": { - "qualifiedName": "RequestQueue", - "sourceFileName": "/src/apify_client/_models.py" - }, - "899": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "900": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "901": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "902": { - "qualifiedName": "user_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "903": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "904": { - "qualifiedName": "modified_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "905": { - "qualifiedName": "accessed_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "906": { - "qualifiedName": "total_request_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "907": { - "qualifiedName": "handled_request_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "908": { - "qualifiedName": "pending_request_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "909": { - "qualifiedName": "had_multiple_clients", - "sourceFileName": "/src/apify_client/_models.py" - }, - "910": { - "qualifiedName": "console_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "911": { - "qualifiedName": "stats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "912": { - "qualifiedName": "general_access", - "sourceFileName": "/src/apify_client/_models.py" - }, - "913": { - "qualifiedName": "RequestQueueHead", - "sourceFileName": "/src/apify_client/_models.py" - }, - "914": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "915": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify_client/_models.py" - }, - "916": { - "qualifiedName": "queue_modified_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "917": { - "qualifiedName": "had_multiple_clients", - "sourceFileName": "/src/apify_client/_models.py" - }, - "918": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "919": { - "qualifiedName": "RequestQueueResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "920": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "921": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "922": { - "qualifiedName": "RequestQueueShort", - "sourceFileName": "/src/apify_client/_models.py" - }, - "923": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "924": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "925": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "926": { - "qualifiedName": "user_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "927": { - "qualifiedName": "username", - "sourceFileName": "/src/apify_client/_models.py" - }, - "928": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "929": { - "qualifiedName": "modified_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "930": { - "qualifiedName": "accessed_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "931": { - "qualifiedName": "expire_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "932": { - "qualifiedName": "total_request_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "933": { - "qualifiedName": "handled_request_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "934": { - "qualifiedName": "pending_request_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "935": { - "qualifiedName": "act_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "936": { - "qualifiedName": "act_run_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "937": { - "qualifiedName": "had_multiple_clients", - "sourceFileName": "/src/apify_client/_models.py" - }, - "938": { - "qualifiedName": "RequestQueueStats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "939": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "940": { - "qualifiedName": "delete_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "941": { - "qualifiedName": "head_item_read_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "942": { - "qualifiedName": "read_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "943": { - "qualifiedName": "storage_bytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "944": { - "qualifiedName": "write_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "945": { - "qualifiedName": "RequestQueues", - "sourceFileName": "/src/apify_client/_models.py" - }, - "946": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "947": { - "qualifiedName": "default", - "sourceFileName": "/src/apify_client/_models.py" - }, - "948": { - "qualifiedName": "RequestRegistration", - "sourceFileName": "/src/apify_client/_models.py" - }, - "949": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "950": { - "qualifiedName": "request_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "951": { - "qualifiedName": "was_already_present", - "sourceFileName": "/src/apify_client/_models.py" - }, - "952": { - "qualifiedName": "was_already_handled", - "sourceFileName": "/src/apify_client/_models.py" - }, - "953": { - "qualifiedName": "RequestResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "954": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "955": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "956": { - "qualifiedName": "RequestUserData", - "sourceFileName": "/src/apify_client/_models.py" - }, - "957": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "958": { - "qualifiedName": "Run", - "sourceFileName": "/src/apify_client/_models.py" - }, - "959": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "960": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "961": { - "qualifiedName": "act_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "962": { - "qualifiedName": "user_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "963": { - "qualifiedName": "actor_task_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "964": { - "qualifiedName": "started_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "965": { - "qualifiedName": "finished_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "966": { - "qualifiedName": "status", - "sourceFileName": "/src/apify_client/_models.py" - }, - "967": { - "qualifiedName": "status_message", - "sourceFileName": "/src/apify_client/_models.py" - }, - "968": { - "qualifiedName": "is_status_message_terminal", - "sourceFileName": "/src/apify_client/_models.py" - }, - "969": { - "qualifiedName": "meta", - "sourceFileName": "/src/apify_client/_models.py" - }, - "970": { - "qualifiedName": "pricing_info", - "sourceFileName": "/src/apify_client/_models.py" - }, - "971": { - "qualifiedName": "stats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "972": { - "qualifiedName": "charged_event_counts", - "sourceFileName": "/src/apify_client/_models.py" - }, - "973": { - "qualifiedName": "options", - "sourceFileName": "/src/apify_client/_models.py" - }, - "974": { - "qualifiedName": "build_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "975": { - "qualifiedName": "exit_code", - "sourceFileName": "/src/apify_client/_models.py" - }, - "976": { - "qualifiedName": "general_access", - "sourceFileName": "/src/apify_client/_models.py" - }, - "977": { - "qualifiedName": "default_key_value_store_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "978": { - "qualifiedName": "default_dataset_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "979": { - "qualifiedName": "default_request_queue_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "980": { - "qualifiedName": "storage_ids", - "sourceFileName": "/src/apify_client/_models.py" - }, - "981": { - "qualifiedName": "build_number", - "sourceFileName": "/src/apify_client/_models.py" - }, - "982": { - "qualifiedName": "container_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "983": { - "qualifiedName": "is_container_server_ready", - "sourceFileName": "/src/apify_client/_models.py" - }, - "984": { - "qualifiedName": "git_branch_name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "985": { - "qualifiedName": "usage", - "sourceFileName": "/src/apify_client/_models.py" - }, - "986": { - "qualifiedName": "usage_total_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "987": { - "qualifiedName": "usage_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "988": { - "qualifiedName": "metamorphs", - "sourceFileName": "/src/apify_client/_models.py" - }, - "989": { - "qualifiedName": "RunFailedErrorDetail", - "sourceFileName": "/src/apify_client/_models.py" - }, - "990": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "991": { - "qualifiedName": "type", - "sourceFileName": "/src/apify_client/_models.py" - }, - "992": { - "qualifiedName": "RunMeta", - "sourceFileName": "/src/apify_client/_models.py" - }, - "993": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "994": { - "qualifiedName": "origin", - "sourceFileName": "/src/apify_client/_models.py" - }, - "995": { - "qualifiedName": "client_ip", - "sourceFileName": "/src/apify_client/_models.py" - }, - "996": { - "qualifiedName": "user_agent", - "sourceFileName": "/src/apify_client/_models.py" - }, - "997": { - "qualifiedName": "schedule_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "998": { - "qualifiedName": "scheduled_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "999": { - "qualifiedName": "RunOptions", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1000": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1001": { - "qualifiedName": "build", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1002": { - "qualifiedName": "timeout_secs", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1003": { - "qualifiedName": "memory_mbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1004": { - "qualifiedName": "disk_mbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1005": { - "qualifiedName": "max_items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1006": { - "qualifiedName": "max_total_charge_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1007": { - "qualifiedName": "RunResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1008": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1009": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1010": { - "qualifiedName": "RunShort", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1011": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1012": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1013": { - "qualifiedName": "act_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1014": { - "qualifiedName": "actor_task_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1015": { - "qualifiedName": "status", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1016": { - "qualifiedName": "started_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1017": { - "qualifiedName": "finished_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1018": { - "qualifiedName": "build_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1019": { - "qualifiedName": "build_number", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1020": { - "qualifiedName": "meta", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1021": { - "qualifiedName": "usage_total_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1022": { - "qualifiedName": "default_key_value_store_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1023": { - "qualifiedName": "default_dataset_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1024": { - "qualifiedName": "default_request_queue_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1025": { - "qualifiedName": "RunStats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1026": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1027": { - "qualifiedName": "input_body_len", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1028": { - "qualifiedName": "migration_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1029": { - "qualifiedName": "reboot_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1030": { - "qualifiedName": "restart_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1031": { - "qualifiedName": "resurrect_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1032": { - "qualifiedName": "mem_avg_bytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1033": { - "qualifiedName": "mem_max_bytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1034": { - "qualifiedName": "mem_current_bytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1035": { - "qualifiedName": "cpu_avg_usage", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1036": { - "qualifiedName": "cpu_max_usage", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1037": { - "qualifiedName": "cpu_current_usage", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1038": { - "qualifiedName": "net_rx_bytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1039": { - "qualifiedName": "net_tx_bytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1040": { - "qualifiedName": "duration_millis", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1041": { - "qualifiedName": "run_time_secs", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1042": { - "qualifiedName": "metamorph", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1043": { - "qualifiedName": "compute_units", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1044": { - "qualifiedName": "RunTimeoutExceededErrorDetail", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1045": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1046": { - "qualifiedName": "type", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1047": { - "qualifiedName": "RunUsage", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1048": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1049": { - "qualifiedName": "actor_compute_units", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1050": { - "qualifiedName": "dataset_reads", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1051": { - "qualifiedName": "dataset_writes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1052": { - "qualifiedName": "key_value_store_reads", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1053": { - "qualifiedName": "key_value_store_writes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1054": { - "qualifiedName": "key_value_store_lists", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1055": { - "qualifiedName": "request_queue_reads", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1056": { - "qualifiedName": "request_queue_writes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1057": { - "qualifiedName": "data_transfer_internal_gbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1058": { - "qualifiedName": "data_transfer_external_gbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1059": { - "qualifiedName": "proxy_residential_transfer_gbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1060": { - "qualifiedName": "proxy_serps", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1061": { - "qualifiedName": "RunUsageUsd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1062": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1063": { - "qualifiedName": "actor_compute_units", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1064": { - "qualifiedName": "dataset_reads", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1065": { - "qualifiedName": "dataset_writes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1066": { - "qualifiedName": "key_value_store_reads", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1067": { - "qualifiedName": "key_value_store_writes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1068": { - "qualifiedName": "key_value_store_lists", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1069": { - "qualifiedName": "request_queue_reads", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1070": { - "qualifiedName": "request_queue_writes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1071": { - "qualifiedName": "data_transfer_internal_gbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1072": { - "qualifiedName": "data_transfer_external_gbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1073": { - "qualifiedName": "proxy_residential_transfer_gbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1074": { - "qualifiedName": "proxy_serps", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1075": { - "qualifiedName": "ScheduleActionRunActor", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1076": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1077": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1078": { - "qualifiedName": "type", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1079": { - "qualifiedName": "actor_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1080": { - "qualifiedName": "run_input", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1081": { - "qualifiedName": "run_options", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1082": { - "qualifiedName": "ScheduleActionRunActorTask", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1083": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1084": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1085": { - "qualifiedName": "type", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1086": { - "qualifiedName": "actor_task_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1087": { - "qualifiedName": "input", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1088": { - "qualifiedName": "ScheduleActionRunInput", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1089": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1090": { - "qualifiedName": "body", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1091": { - "qualifiedName": "content_type", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1092": { - "qualifiedName": "ScheduleActionShortRunActor", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1093": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1094": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1095": { - "qualifiedName": "type", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1096": { - "qualifiedName": "actor_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1097": { - "qualifiedName": "ScheduleActionShortRunActorTask", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1098": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1099": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1100": { - "qualifiedName": "type", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1101": { - "qualifiedName": "actor_task_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1102": { - "qualifiedName": "ScheduleBase", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1103": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1104": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1105": { - "qualifiedName": "user_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1106": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1107": { - "qualifiedName": "cron_expression", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1108": { - "qualifiedName": "timezone", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1109": { - "qualifiedName": "is_enabled", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1110": { - "qualifiedName": "is_exclusive", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1111": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1112": { - "qualifiedName": "modified_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1113": { - "qualifiedName": "next_run_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1114": { - "qualifiedName": "last_run_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1115": { - "qualifiedName": "Schedule", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1116": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1117": { - "qualifiedName": "description", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1118": { - "qualifiedName": "title", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1119": { - "qualifiedName": "actions", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1120": { - "qualifiedName": "ScheduleCreate", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1121": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1122": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1123": { - "qualifiedName": "is_enabled", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1124": { - "qualifiedName": "is_exclusive", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1125": { - "qualifiedName": "cron_expression", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1126": { - "qualifiedName": "timezone", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1127": { - "qualifiedName": "description", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1128": { - "qualifiedName": "title", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1129": { - "qualifiedName": "actions", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1130": { - "qualifiedName": "ScheduleCreateActionRunActor", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1131": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1132": { - "qualifiedName": "type", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1133": { - "qualifiedName": "actor_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1134": { - "qualifiedName": "run_input", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1135": { - "qualifiedName": "run_options", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1136": { - "qualifiedName": "ScheduleCreateActionRunActorTask", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1137": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1138": { - "qualifiedName": "type", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1139": { - "qualifiedName": "actor_task_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1140": { - "qualifiedName": "input", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1141": { - "qualifiedName": "ScheduleInvoked", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1142": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1143": { - "qualifiedName": "message", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1144": { - "qualifiedName": "level", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1145": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1146": { - "qualifiedName": "ScheduleLogResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1147": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1148": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1149": { - "qualifiedName": "ScheduleResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1150": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1151": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1152": { - "qualifiedName": "ScheduleShort", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1153": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1154": { - "qualifiedName": "actions", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1155": { - "qualifiedName": "SchemaValidationErrorData", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1156": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1157": { - "qualifiedName": "invalid_items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1158": { - "qualifiedName": "SourceCodeFile", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1159": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1160": { - "qualifiedName": "format", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1161": { - "qualifiedName": "content", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1162": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1163": { - "qualifiedName": "SourceCodeFolder", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1164": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1165": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1166": { - "qualifiedName": "folder", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1167": { - "qualifiedName": "StorageIds", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1168": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1169": { - "qualifiedName": "datasets", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1170": { - "qualifiedName": "key_value_stores", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1171": { - "qualifiedName": "request_queues", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1172": { - "qualifiedName": "Storages", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1173": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1174": { - "qualifiedName": "dataset", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1175": { - "qualifiedName": "StoreListActor", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1176": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1177": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1178": { - "qualifiedName": "title", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1179": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1180": { - "qualifiedName": "username", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1181": { - "qualifiedName": "user_full_name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1182": { - "qualifiedName": "description", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1183": { - "qualifiedName": "categories", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1184": { - "qualifiedName": "notice", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1185": { - "qualifiedName": "picture_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1186": { - "qualifiedName": "user_picture_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1187": { - "qualifiedName": "url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1188": { - "qualifiedName": "stats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1189": { - "qualifiedName": "current_pricing_info", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1190": { - "qualifiedName": "is_white_listed_for_agentic_payment", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1191": { - "qualifiedName": "readme_summary", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1192": { - "qualifiedName": "TaggedBuildInfo", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1193": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1194": { - "qualifiedName": "build_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1195": { - "qualifiedName": "build_number", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1196": { - "qualifiedName": "finished_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1197": { - "qualifiedName": "Task", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1198": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1199": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1200": { - "qualifiedName": "user_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1201": { - "qualifiedName": "act_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1202": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1203": { - "qualifiedName": "username", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1204": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1205": { - "qualifiedName": "modified_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1206": { - "qualifiedName": "removed_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1207": { - "qualifiedName": "stats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1208": { - "qualifiedName": "options", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1209": { - "qualifiedName": "input", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1210": { - "qualifiedName": "title", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1211": { - "qualifiedName": "actor_standby", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1212": { - "qualifiedName": "standby_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1213": { - "qualifiedName": "TaskInput", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1214": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1215": { - "qualifiedName": "TaskOptions", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1216": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1217": { - "qualifiedName": "build", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1218": { - "qualifiedName": "timeout_secs", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1219": { - "qualifiedName": "memory_mbytes", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1220": { - "qualifiedName": "max_items", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1221": { - "qualifiedName": "max_total_charge_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1222": { - "qualifiedName": "restart_on_error", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1223": { - "qualifiedName": "TaskResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1224": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1225": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1226": { - "qualifiedName": "TaskShort", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1227": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1228": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1229": { - "qualifiedName": "user_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1230": { - "qualifiedName": "act_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1231": { - "qualifiedName": "act_name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1232": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1233": { - "qualifiedName": "username", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1234": { - "qualifiedName": "act_username", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1235": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1236": { - "qualifiedName": "modified_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1237": { - "qualifiedName": "stats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1238": { - "qualifiedName": "TaskStats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1239": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1240": { - "qualifiedName": "total_runs", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1241": { - "qualifiedName": "TestWebhookResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1242": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1243": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1244": { - "qualifiedName": "UnknownBuildTagError", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1245": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1246": { - "qualifiedName": "error", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1247": { - "qualifiedName": "UnknownBuildTagErrorDetail", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1248": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1249": { - "qualifiedName": "type", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1250": { - "qualifiedName": "UnlockRequestsResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1251": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1252": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1253": { - "qualifiedName": "UnlockRequestsResult", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1254": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1255": { - "qualifiedName": "unlocked_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1256": { - "qualifiedName": "UpdateActorRequest", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1257": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1258": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1259": { - "qualifiedName": "description", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1260": { - "qualifiedName": "is_public", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1261": { - "qualifiedName": "actor_permission_level", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1262": { - "qualifiedName": "seo_title", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1263": { - "qualifiedName": "seo_description", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1264": { - "qualifiedName": "title", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1265": { - "qualifiedName": "restart_on_error", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1266": { - "qualifiedName": "versions", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1267": { - "qualifiedName": "pricing_infos", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1268": { - "qualifiedName": "categories", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1269": { - "qualifiedName": "default_run_options", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1270": { - "qualifiedName": "tagged_builds", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1271": { - "qualifiedName": "actor_standby", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1272": { - "qualifiedName": "example_run_input", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1273": { - "qualifiedName": "is_deprecated", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1274": { - "qualifiedName": "UpdateDatasetRequest", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1275": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1276": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1277": { - "qualifiedName": "general_access", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1278": { - "qualifiedName": "UpdateLimitsRequest", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1279": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1280": { - "qualifiedName": "max_monthly_usage_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1281": { - "qualifiedName": "data_retention_days", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1282": { - "qualifiedName": "UpdateRequestQueueRequest", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1283": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1284": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1285": { - "qualifiedName": "general_access", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1286": { - "qualifiedName": "UpdateRequestResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1287": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1288": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1289": { - "qualifiedName": "UpdateRunRequest", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1290": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1291": { - "qualifiedName": "run_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1292": { - "qualifiedName": "status_message", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1293": { - "qualifiedName": "is_status_message_terminal", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1294": { - "qualifiedName": "general_access", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1295": { - "qualifiedName": "UpdateStoreRequest", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1296": { - "qualifiedName": "UpdateTaskRequest", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1297": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1298": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1299": { - "qualifiedName": "options", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1300": { - "qualifiedName": "input", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1301": { - "qualifiedName": "title", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1302": { - "qualifiedName": "actor_standby", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1303": { - "qualifiedName": "UsageCycle", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1304": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1305": { - "qualifiedName": "start_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1306": { - "qualifiedName": "end_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1307": { - "qualifiedName": "UsageItem", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1308": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1309": { - "qualifiedName": "quantity", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1310": { - "qualifiedName": "base_amount_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1311": { - "qualifiedName": "base_unit_price_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1312": { - "qualifiedName": "amount_after_volume_discount_usd", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1313": { - "qualifiedName": "price_tiers", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1314": { - "qualifiedName": "UserPrivateInfo", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1315": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1316": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1317": { - "qualifiedName": "username", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1318": { - "qualifiedName": "profile", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1319": { - "qualifiedName": "email", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1320": { - "qualifiedName": "proxy", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1321": { - "qualifiedName": "plan", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1322": { - "qualifiedName": "effective_platform_features", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1323": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1324": { - "qualifiedName": "is_paying", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1325": { - "qualifiedName": "UserPublicInfo", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1326": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1327": { - "qualifiedName": "username", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1328": { - "qualifiedName": "profile", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1329": { - "qualifiedName": "ValidationError", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1330": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1331": { - "qualifiedName": "instance_path", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1332": { - "qualifiedName": "schema_path", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1333": { - "qualifiedName": "keyword", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1334": { - "qualifiedName": "message", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1335": { - "qualifiedName": "params", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1336": { - "qualifiedName": "Version", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1337": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1338": { - "qualifiedName": "version_number", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1339": { - "qualifiedName": "source_type", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1340": { - "qualifiedName": "env_vars", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1341": { - "qualifiedName": "apply_env_vars_to_build", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1342": { - "qualifiedName": "build_tag", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1343": { - "qualifiedName": "source_files", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1344": { - "qualifiedName": "git_repo_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1345": { - "qualifiedName": "tarball_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1346": { - "qualifiedName": "github_gist_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1347": { - "qualifiedName": "VersionResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1348": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1349": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1350": { - "qualifiedName": "Webhook", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1351": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1352": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1353": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1354": { - "qualifiedName": "modified_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1355": { - "qualifiedName": "user_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1356": { - "qualifiedName": "is_ad_hoc", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1357": { - "qualifiedName": "should_interpolate_strings", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1358": { - "qualifiedName": "event_types", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1359": { - "qualifiedName": "condition", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1360": { - "qualifiedName": "ignore_ssl_errors", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1361": { - "qualifiedName": "do_not_retry", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1362": { - "qualifiedName": "request_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1363": { - "qualifiedName": "payload_template", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1364": { - "qualifiedName": "headers_template", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1365": { - "qualifiedName": "description", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1366": { - "qualifiedName": "last_dispatch", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1367": { - "qualifiedName": "stats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1368": { - "qualifiedName": "WebhookCondition", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1369": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1370": { - "qualifiedName": "actor_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1371": { - "qualifiedName": "actor_task_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1372": { - "qualifiedName": "actor_run_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1373": { - "qualifiedName": "WebhookCreate", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1374": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1375": { - "qualifiedName": "is_ad_hoc", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1376": { - "qualifiedName": "event_types", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1377": { - "qualifiedName": "condition", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1378": { - "qualifiedName": "idempotency_key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1379": { - "qualifiedName": "ignore_ssl_errors", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1380": { - "qualifiedName": "do_not_retry", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1381": { - "qualifiedName": "request_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1382": { - "qualifiedName": "payload_template", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1383": { - "qualifiedName": "headers_template", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1384": { - "qualifiedName": "description", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1385": { - "qualifiedName": "should_interpolate_strings", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1386": { - "qualifiedName": "WebhookDispatch", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1387": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1388": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1389": { - "qualifiedName": "user_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1390": { - "qualifiedName": "webhook_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1391": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1392": { - "qualifiedName": "status", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1393": { - "qualifiedName": "event_type", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1394": { - "qualifiedName": "event_data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1395": { - "qualifiedName": "calls", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1396": { - "qualifiedName": "WebhookDispatchResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1397": { - "qualifiedName": "WebhookRepresentation", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1398": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1399": { - "qualifiedName": "event_types", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1400": { - "qualifiedName": "request_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1401": { - "qualifiedName": "payload_template", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1402": { - "qualifiedName": "headers_template", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1403": { - "qualifiedName": "WebhookResponse", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1404": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1405": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1406": { - "qualifiedName": "WebhookShort", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1407": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1408": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1409": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1410": { - "qualifiedName": "modified_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1411": { - "qualifiedName": "user_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1412": { - "qualifiedName": "is_ad_hoc", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1413": { - "qualifiedName": "should_interpolate_strings", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1414": { - "qualifiedName": "event_types", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1415": { - "qualifiedName": "condition", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1416": { - "qualifiedName": "ignore_ssl_errors", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1417": { - "qualifiedName": "do_not_retry", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1418": { - "qualifiedName": "request_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1419": { - "qualifiedName": "last_dispatch", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1420": { - "qualifiedName": "stats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1421": { - "qualifiedName": "WebhookStats", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1422": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1423": { - "qualifiedName": "total_dispatches", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1424": { - "qualifiedName": "WebhookUpdate", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1425": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1426": { - "qualifiedName": "is_ad_hoc", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1427": { - "qualifiedName": "event_types", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1428": { - "qualifiedName": "condition", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1429": { - "qualifiedName": "ignore_ssl_errors", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1430": { - "qualifiedName": "do_not_retry", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1431": { - "qualifiedName": "request_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1432": { - "qualifiedName": "payload_template", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1433": { - "qualifiedName": "headers_template", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1434": { - "qualifiedName": "description", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1435": { - "qualifiedName": "should_interpolate_strings", - "sourceFileName": "/src/apify_client/_models.py" - }, - "1436": { - "qualifiedName": "ApifyClient", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1437": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1449": { - "qualifiedName": "with_custom_http_client", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1455": { - "qualifiedName": "token", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1456": { - "qualifiedName": "http_client", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1457": { - "qualifiedName": "actor", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1460": { - "qualifiedName": "actors", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1462": { - "qualifiedName": "build", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1465": { - "qualifiedName": "builds", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1467": { - "qualifiedName": "run", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1470": { - "qualifiedName": "runs", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1472": { - "qualifiedName": "dataset", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1475": { - "qualifiedName": "datasets", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1477": { - "qualifiedName": "key_value_store", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1480": { - "qualifiedName": "key_value_stores", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1482": { - "qualifiedName": "request_queue", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1486": { - "qualifiedName": "request_queues", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1488": { - "qualifiedName": "webhook", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1491": { - "qualifiedName": "webhooks", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1493": { - "qualifiedName": "webhook_dispatch", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1496": { - "qualifiedName": "webhook_dispatches", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1498": { - "qualifiedName": "schedule", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1501": { - "qualifiedName": "schedules", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1503": { - "qualifiedName": "log", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1506": { - "qualifiedName": "task", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1509": { - "qualifiedName": "tasks", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1511": { - "qualifiedName": "user", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1514": { - "qualifiedName": "store", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1516": { - "qualifiedName": "ApifyClientAsync", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1517": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1529": { - "qualifiedName": "with_custom_http_client", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1535": { - "qualifiedName": "token", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1536": { - "qualifiedName": "http_client", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1537": { - "qualifiedName": "actor", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1540": { - "qualifiedName": "actors", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1542": { - "qualifiedName": "build", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1545": { - "qualifiedName": "builds", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1547": { - "qualifiedName": "run", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1550": { - "qualifiedName": "runs", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1552": { - "qualifiedName": "dataset", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1555": { - "qualifiedName": "datasets", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1557": { - "qualifiedName": "key_value_store", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1560": { - "qualifiedName": "key_value_stores", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1562": { - "qualifiedName": "request_queue", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1566": { - "qualifiedName": "request_queues", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1568": { - "qualifiedName": "webhook", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1571": { - "qualifiedName": "webhooks", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1573": { - "qualifiedName": "webhook_dispatch", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1576": { - "qualifiedName": "webhook_dispatches", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1578": { - "qualifiedName": "schedule", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1581": { - "qualifiedName": "schedules", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1583": { - "qualifiedName": "log", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1586": { - "qualifiedName": "task", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1589": { - "qualifiedName": "tasks", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1591": { - "qualifiedName": "user", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1594": { - "qualifiedName": "store", - "sourceFileName": "/src/apify_client/_apify_client.py" - }, - "1596": { - "qualifiedName": "__version__", - "sourceFileName": "/src/apify_client/__init__.py" - }, - "1597": { - "qualifiedName": "logger_name", - "sourceFileName": "/src/apify_client/_logging.py" - }, - "1598": { - "qualifiedName": "logger", - "sourceFileName": "/src/apify_client/_logging.py" - }, - "1599": { - "qualifiedName": "LogContext", - "sourceFileName": "/src/apify_client/_logging.py" - }, - "1600": { - "qualifiedName": "attempt", - "sourceFileName": "/src/apify_client/_logging.py" - }, - "1601": { - "qualifiedName": "client_method", - "sourceFileName": "/src/apify_client/_logging.py" - }, - "1602": { - "qualifiedName": "method", - "sourceFileName": "/src/apify_client/_logging.py" - }, - "1603": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_logging.py" - }, - "1604": { - "qualifiedName": "url", - "sourceFileName": "/src/apify_client/_logging.py" - }, - "1605": { - "qualifiedName": "log_context", - "sourceFileName": "/src/apify_client/_logging.py" - }, - "1606": { - "qualifiedName": "WithLogDetailsClient", - "sourceFileName": "/src/apify_client/_logging.py" - }, - "1607": { - "qualifiedName": "__new__", - "sourceFileName": "/src/apify_client/_logging.py" - }, - "1612": { - "qualifiedName": "RedirectLogFormatter", - "sourceFileName": "/src/apify_client/_logging.py" - }, - "1613": { - "qualifiedName": "format", - "sourceFileName": "/src/apify_client/_logging.py" - }, - "1616": { - "qualifiedName": "create_redirect_logger", - "sourceFileName": "/src/apify_client/_logging.py" - }, - "1619": { - "qualifiedName": "_ContextInjectingFilter", - "sourceFileName": "/src/apify_client/_logging.py" - }, - "1620": { - "qualifiedName": "filter", - "sourceFileName": "/src/apify_client/_logging.py" - }, - "1623": { - "qualifiedName": "T", - "sourceFileName": "/src/apify_client/_utils.py" - }, - "1624": { - "qualifiedName": "to_seconds", - "sourceFileName": "/src/apify_client/_utils.py" - }, - "1628": { - "qualifiedName": "catch_not_found_or_throw", - "sourceFileName": "/src/apify_client/_utils.py" - }, - "1631": { - "qualifiedName": "catch_not_found_for_resource_or_throw", - "sourceFileName": "/src/apify_client/_utils.py" - }, - "1635": { - "qualifiedName": "encode_key_value_store_record_value", - "sourceFileName": "/src/apify_client/_utils.py" - }, - "1639": { - "qualifiedName": "is_retryable_error", - "sourceFileName": "/src/apify_client/_utils.py" - }, - "1642": { - "qualifiedName": "to_safe_id", - "sourceFileName": "/src/apify_client/_utils.py" - }, - "1645": { - "qualifiedName": "response_to_dict", - "sourceFileName": "/src/apify_client/_utils.py" - }, - "1648": { - "qualifiedName": "response_to_list", - "sourceFileName": "/src/apify_client/_utils.py" - }, - "1651": { - "qualifiedName": "encode_base62", - "sourceFileName": "/src/apify_client/_utils.py" - }, - "1654": { - "qualifiedName": "create_hmac_signature", - "sourceFileName": "/src/apify_client/_utils.py" - }, - "1658": { - "qualifiedName": "create_storage_content_signature", - "sourceFileName": "/src/apify_client/_utils.py" - }, - "1664": { - "qualifiedName": "check_custom_headers", - "sourceFileName": "/src/apify_client/_utils.py" - }, - "1668": { - "qualifiedName": "encode_webhooks_to_base64", - "sourceFileName": "/src/apify_client/_utils.py" - }, - "1671": { - "qualifiedName": "StatusMessageWatcherBase", - "sourceFileName": "/src/apify_client/_status_message_watcher.py" - }, - "1672": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_status_message_watcher.py" - }, - "1676": { - "qualifiedName": "StatusMessageWatcherAsync", - "sourceFileName": "/src/apify_client/_status_message_watcher.py" - }, - "1677": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_status_message_watcher.py" - }, - "1682": { - "qualifiedName": "start", - "sourceFileName": "/src/apify_client/_status_message_watcher.py" - }, - "1684": { - "qualifiedName": "stop", - "sourceFileName": "/src/apify_client/_status_message_watcher.py" - }, - "1686": { - "qualifiedName": "__aenter__", - "sourceFileName": "/src/apify_client/_status_message_watcher.py" - }, - "1688": { - "qualifiedName": "__aexit__", - "sourceFileName": "/src/apify_client/_status_message_watcher.py" - }, - "1693": { - "qualifiedName": "StatusMessageWatcher", - "sourceFileName": "/src/apify_client/_status_message_watcher.py" - }, - "1694": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_status_message_watcher.py" - }, - "1699": { - "qualifiedName": "start", - "sourceFileName": "/src/apify_client/_status_message_watcher.py" - }, - "1701": { - "qualifiedName": "stop", - "sourceFileName": "/src/apify_client/_status_message_watcher.py" - }, - "1703": { - "qualifiedName": "__enter__", - "sourceFileName": "/src/apify_client/_status_message_watcher.py" - }, - "1705": { - "qualifiedName": "__exit__", - "sourceFileName": "/src/apify_client/_status_message_watcher.py" - }, - "1710": { - "qualifiedName": "ClientRegistry", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1711": { - "qualifiedName": "actor_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1712": { - "qualifiedName": "actor_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1713": { - "qualifiedName": "actor_env_var_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1714": { - "qualifiedName": "actor_env_var_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1715": { - "qualifiedName": "actor_version_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1716": { - "qualifiedName": "actor_version_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1717": { - "qualifiedName": "build_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1718": { - "qualifiedName": "build_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1719": { - "qualifiedName": "dataset_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1720": { - "qualifiedName": "dataset_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1721": { - "qualifiedName": "key_value_store_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1722": { - "qualifiedName": "key_value_store_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1723": { - "qualifiedName": "log_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1724": { - "qualifiedName": "request_queue_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1725": { - "qualifiedName": "request_queue_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1726": { - "qualifiedName": "run_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1727": { - "qualifiedName": "run_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1728": { - "qualifiedName": "schedule_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1729": { - "qualifiedName": "schedule_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1730": { - "qualifiedName": "store_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1731": { - "qualifiedName": "task_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1732": { - "qualifiedName": "task_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1733": { - "qualifiedName": "user_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1734": { - "qualifiedName": "webhook_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1735": { - "qualifiedName": "webhook_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1736": { - "qualifiedName": "webhook_dispatch_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1737": { - "qualifiedName": "webhook_dispatch_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1738": { - "qualifiedName": "ClientRegistryAsync", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1739": { - "qualifiedName": "actor_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1740": { - "qualifiedName": "actor_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1741": { - "qualifiedName": "actor_env_var_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1742": { - "qualifiedName": "actor_env_var_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1743": { - "qualifiedName": "actor_version_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1744": { - "qualifiedName": "actor_version_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1745": { - "qualifiedName": "build_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1746": { - "qualifiedName": "build_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1747": { - "qualifiedName": "dataset_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1748": { - "qualifiedName": "dataset_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1749": { - "qualifiedName": "key_value_store_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1750": { - "qualifiedName": "key_value_store_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1751": { - "qualifiedName": "log_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1752": { - "qualifiedName": "request_queue_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1753": { - "qualifiedName": "request_queue_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1754": { - "qualifiedName": "run_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1755": { - "qualifiedName": "run_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1756": { - "qualifiedName": "schedule_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1757": { - "qualifiedName": "schedule_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1758": { - "qualifiedName": "store_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1759": { - "qualifiedName": "task_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1760": { - "qualifiedName": "task_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1761": { - "qualifiedName": "user_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1762": { - "qualifiedName": "webhook_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1763": { - "qualifiedName": "webhook_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1764": { - "qualifiedName": "webhook_dispatch_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1765": { - "qualifiedName": "webhook_dispatch_collection_client", - "sourceFileName": "/src/apify_client/_client_registry.py" - }, - "1766": { - "qualifiedName": "T", - "sourceFileName": "/src/apify_client/_pagination.py" - }, - "1767": { - "qualifiedName": "DEFAULT_CHUNK_SIZE", - "sourceFileName": "/src/apify_client/_pagination.py" - }, - "1768": { - "qualifiedName": "HasItems", - "sourceFileName": "/src/apify_client/_pagination.py" - }, - "1769": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_pagination.py" - }, - "1770": { - "qualifiedName": "get_items_iterator", - "sourceFileName": "/src/apify_client/_pagination.py" - }, - "1776": { - "qualifiedName": "get_items_iterator_async", - "sourceFileName": "/src/apify_client/_pagination.py" - }, - "1782": { - "qualifiedName": "get_cursor_iterator", - "sourceFileName": "/src/apify_client/_pagination.py" - }, - "1788": { - "qualifiedName": "get_cursor_iterator_async", - "sourceFileName": "/src/apify_client/_pagination.py" - }, - "1794": { - "qualifiedName": "ActorJobStatus", - "sourceFileName": "/src/apify_client/_literals.py" - }, - "1795": { - "qualifiedName": "ActorPermissionLevel", - "sourceFileName": "/src/apify_client/_literals.py" - }, - "1796": { - "qualifiedName": "ErrorType", - "sourceFileName": "/src/apify_client/_literals.py" - }, - "1797": { - "qualifiedName": "GeneralAccess", - "sourceFileName": "/src/apify_client/_literals.py" - }, - "1798": { - "qualifiedName": "HttpMethod", - "sourceFileName": "/src/apify_client/_literals.py" - }, - "1799": { - "qualifiedName": "RunOrigin", - "sourceFileName": "/src/apify_client/_literals.py" - }, - "1800": { - "qualifiedName": "SourceCodeFileFormat", - "sourceFileName": "/src/apify_client/_literals.py" - }, - "1801": { - "qualifiedName": "StorageOwnership", - "sourceFileName": "/src/apify_client/_literals.py" - }, - "1802": { - "qualifiedName": "VersionSourceType", - "sourceFileName": "/src/apify_client/_literals.py" - }, - "1803": { - "qualifiedName": "WebhookDispatchStatus", - "sourceFileName": "/src/apify_client/_literals.py" - }, - "1804": { - "qualifiedName": "WebhookEventType", - "sourceFileName": "/src/apify_client/_literals.py" - }, - "1805": { - "qualifiedName": "HttpResponse", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "1806": { - "qualifiedName": "status_code", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "1807": { - "qualifiedName": "text", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "1808": { - "qualifiedName": "content", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "1809": { - "qualifiedName": "headers", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "1810": { - "qualifiedName": "json", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "1812": { - "qualifiedName": "read", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "1814": { - "qualifiedName": "aread", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "1816": { - "qualifiedName": "close", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "1818": { - "qualifiedName": "aclose", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "1820": { - "qualifiedName": "iter_bytes", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "1822": { - "qualifiedName": "aiter_bytes", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "1824": { - "qualifiedName": "HttpClientBase", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "1825": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "1836": { - "qualifiedName": "HttpClient", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "1837": { - "qualifiedName": "call", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "1847": { - "qualifiedName": "HttpClientAsync", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "1848": { - "qualifiedName": "call", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "1858": { - "qualifiedName": "T", - "sourceFileName": "/src/apify_client/http_clients/_impit.py" - }, - "1859": { - "qualifiedName": "logger", - "sourceFileName": "/src/apify_client/http_clients/_impit.py" - }, - "1860": { - "qualifiedName": "ImpitHttpClient", - "sourceFileName": "/src/apify_client/http_clients/_impit.py" - }, - "1861": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/http_clients/_impit.py" - }, - "1872": { - "qualifiedName": "call", - "sourceFileName": "/src/apify_client/http_clients/_impit.py" - }, - "1882": { - "qualifiedName": "ImpitHttpClientAsync", - "sourceFileName": "/src/apify_client/http_clients/_impit.py" - }, - "1883": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/http_clients/_impit.py" - }, - "1894": { - "qualifiedName": "call", - "sourceFileName": "/src/apify_client/http_clients/_impit.py" - }, - "1904": { - "qualifiedName": "ScheduleClient", - "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" - }, - "1905": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" - }, - "1910": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" - }, - "1913": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" - }, - "1924": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" - }, - "1927": { - "qualifiedName": "get_log", - "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" - }, - "1930": { - "qualifiedName": "ScheduleClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" - }, - "1931": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" - }, - "1936": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" - }, - "1939": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" - }, - "1950": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" - }, - "1953": { - "qualifiedName": "get_log", - "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" - }, - "1956": { - "qualifiedName": "UserClient", - "sourceFileName": "/src/apify_client/_resource_clients/user.py" - }, - "1957": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/user.py" - }, - "1962": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/user.py" - }, - "1965": { - "qualifiedName": "monthly_usage", - "sourceFileName": "/src/apify_client/_resource_clients/user.py" - }, - "1968": { - "qualifiedName": "limits", - "sourceFileName": "/src/apify_client/_resource_clients/user.py" - }, - "1971": { - "qualifiedName": "update_limits", - "sourceFileName": "/src/apify_client/_resource_clients/user.py" - }, - "1976": { - "qualifiedName": "UserClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/user.py" - }, - "1977": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/user.py" - }, - "1982": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/user.py" - }, - "1985": { - "qualifiedName": "monthly_usage", - "sourceFileName": "/src/apify_client/_resource_clients/user.py" - }, - "1988": { - "qualifiedName": "limits", - "sourceFileName": "/src/apify_client/_resource_clients/user.py" - }, - "1991": { - "qualifiedName": "update_limits", - "sourceFileName": "/src/apify_client/_resource_clients/user.py" - }, - "1996": { - "qualifiedName": "RequestQueueClient", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "1997": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2003": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2006": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2011": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2014": { - "qualifiedName": "list_head", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2018": { - "qualifiedName": "list_and_lock_head", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2023": { - "qualifiedName": "add_request", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2028": { - "qualifiedName": "get_request", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2032": { - "qualifiedName": "update_request", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2037": { - "qualifiedName": "delete_request", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2041": { - "qualifiedName": "prolong_request_lock", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2047": { - "qualifiedName": "delete_request_lock", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2052": { - "qualifiedName": "batch_add_requests", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2058": { - "qualifiedName": "batch_delete_requests", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2062": { - "qualifiedName": "list_requests", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2068": { - "qualifiedName": "iterate_requests", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2075": { - "qualifiedName": "unlock_requests", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2078": { - "qualifiedName": "RequestQueueClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2079": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2085": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2088": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2093": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2096": { - "qualifiedName": "list_head", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2100": { - "qualifiedName": "list_and_lock_head", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2105": { - "qualifiedName": "add_request", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2110": { - "qualifiedName": "get_request", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2114": { - "qualifiedName": "update_request", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2119": { - "qualifiedName": "delete_request", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2123": { - "qualifiedName": "prolong_request_lock", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2129": { - "qualifiedName": "delete_request_lock", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2134": { - "qualifiedName": "batch_add_requests", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2140": { - "qualifiedName": "batch_delete_requests", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2144": { - "qualifiedName": "list_requests", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2150": { - "qualifiedName": "iterate_requests", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2157": { - "qualifiedName": "unlock_requests", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" - }, - "2160": { - "qualifiedName": "LogClient", - "sourceFileName": "/src/apify_client/_resource_clients/log.py" - }, - "2161": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/log.py" - }, - "2165": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/log.py" - }, - "2169": { - "qualifiedName": "get_as_bytes", - "sourceFileName": "/src/apify_client/_resource_clients/log.py" - }, - "2173": { - "qualifiedName": "stream", - "sourceFileName": "/src/apify_client/_resource_clients/log.py" - }, - "2177": { - "qualifiedName": "LogClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/log.py" - }, - "2178": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/log.py" - }, - "2182": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/log.py" - }, - "2186": { - "qualifiedName": "get_as_bytes", - "sourceFileName": "/src/apify_client/_resource_clients/log.py" - }, - "2190": { - "qualifiedName": "stream", - "sourceFileName": "/src/apify_client/_resource_clients/log.py" - }, - "2194": { - "qualifiedName": "ActorEnvVarCollectionClient", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" - }, - "2195": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" - }, - "2199": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" - }, - "2202": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" - }, - "2205": { - "qualifiedName": "create", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" - }, - "2211": { - "qualifiedName": "ActorEnvVarCollectionClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" - }, - "2212": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" - }, - "2216": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" - }, - "2219": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" - }, - "2222": { - "qualifiedName": "create", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" - }, - "2228": { - "qualifiedName": "WebhookDispatchCollectionClient", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py" - }, - "2229": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py" - }, - "2233": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py" - }, - "2239": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py" - }, - "2245": { - "qualifiedName": "WebhookDispatchCollectionClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py" - }, - "2246": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py" - }, - "2250": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py" - }, - "2256": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py" - }, - "2262": { - "qualifiedName": "ActorCollectionClient", - "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" - }, - "2263": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" - }, - "2267": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" - }, - "2275": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" - }, - "2283": { - "qualifiedName": "create", - "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" - }, - "2308": { - "qualifiedName": "ActorCollectionClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" - }, - "2309": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" - }, - "2313": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" - }, - "2321": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" - }, - "2329": { - "qualifiedName": "create", - "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" - }, - "2354": { - "qualifiedName": "WebhookDispatchClient", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch.py" - }, - "2355": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch.py" - }, - "2360": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch.py" - }, - "2363": { - "qualifiedName": "WebhookDispatchClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch.py" - }, - "2364": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch.py" - }, - "2369": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch.py" - }, - "2372": { - "qualifiedName": "KeyValueStoreCollectionClient", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" - }, - "2373": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" - }, - "2377": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" - }, - "2385": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" - }, - "2393": { - "qualifiedName": "get_or_create", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" - }, - "2398": { - "qualifiedName": "KeyValueStoreCollectionClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" - }, - "2399": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" - }, - "2403": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" - }, - "2411": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" - }, - "2419": { - "qualifiedName": "get_or_create", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" - }, - "2424": { - "qualifiedName": "ActorVersionClient", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" - }, - "2425": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" - }, - "2430": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" - }, - "2433": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" - }, - "2444": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" - }, - "2447": { - "qualifiedName": "env_vars", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" - }, - "2449": { - "qualifiedName": "env_var", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" - }, - "2452": { - "qualifiedName": "ActorVersionClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" - }, - "2453": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" - }, - "2458": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" - }, - "2461": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" - }, - "2472": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" - }, - "2475": { - "qualifiedName": "env_vars", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" - }, - "2477": { - "qualifiedName": "env_var", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" - }, - "2480": { - "qualifiedName": "RequestQueueCollectionClient", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" - }, - "2481": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" - }, - "2485": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" - }, - "2493": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" - }, - "2501": { - "qualifiedName": "get_or_create", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" - }, - "2505": { - "qualifiedName": "RequestQueueCollectionClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" - }, - "2506": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" - }, - "2510": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" - }, - "2518": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" - }, - "2526": { - "qualifiedName": "get_or_create", - "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" - }, - "2530": { - "qualifiedName": "TaskCollectionClient", - "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" - }, - "2531": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" - }, - "2535": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" - }, - "2541": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" - }, - "2547": { - "qualifiedName": "create", - "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" - }, - "2564": { - "qualifiedName": "TaskCollectionClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" - }, - "2565": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" - }, - "2569": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" - }, - "2575": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" - }, - "2581": { - "qualifiedName": "create", - "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" - }, - "2598": { - "qualifiedName": "StoreCollectionClient", - "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py" - }, - "2599": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py" - }, - "2603": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py" - }, - "2613": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py" - }, - "2623": { - "qualifiedName": "StoreCollectionClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py" - }, - "2624": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py" - }, - "2628": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py" - }, - "2638": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py" - }, - "2648": { - "qualifiedName": "TaskClient", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2649": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2654": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2657": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2673": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2676": { - "qualifiedName": "start", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2687": { - "qualifiedName": "call", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2698": { - "qualifiedName": "get_input", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2701": { - "qualifiedName": "update_input", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2705": { - "qualifiedName": "runs", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2707": { - "qualifiedName": "last_run", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2711": { - "qualifiedName": "webhooks", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2713": { - "qualifiedName": "TaskClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2714": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2719": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2722": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2738": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2741": { - "qualifiedName": "start", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2752": { - "qualifiedName": "call", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2763": { - "qualifiedName": "get_input", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2766": { - "qualifiedName": "update_input", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2770": { - "qualifiedName": "runs", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2772": { - "qualifiedName": "last_run", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2776": { - "qualifiedName": "webhooks", - "sourceFileName": "/src/apify_client/_resource_clients/task.py" - }, - "2778": { - "qualifiedName": "BuildCollectionClient", - "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py" - }, - "2779": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py" - }, - "2783": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py" - }, - "2789": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py" - }, - "2795": { - "qualifiedName": "BuildCollectionClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py" - }, - "2796": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py" - }, - "2800": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py" - }, - "2806": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py" - }, - "2812": { - "qualifiedName": "DatasetItemsPage", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2813": { - "qualifiedName": "items", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2814": { - "qualifiedName": "total", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2815": { - "qualifiedName": "offset", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2816": { - "qualifiedName": "count", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2817": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2818": { - "qualifiedName": "desc", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2819": { - "qualifiedName": "DatasetClient", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2820": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2825": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2828": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2833": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2836": { - "qualifiedName": "list_items", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2851": { - "qualifiedName": "iterate_items", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2865": { - "qualifiedName": "get_items_as_bytes", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2885": { - "qualifiedName": "stream_items", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2904": { - "qualifiedName": "push_items", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2908": { - "qualifiedName": "get_statistics", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2911": { - "qualifiedName": "create_items_public_url", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2926": { - "qualifiedName": "DatasetClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2927": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2932": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2935": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2940": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2943": { - "qualifiedName": "list_items", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2958": { - "qualifiedName": "iterate_items", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2972": { - "qualifiedName": "get_items_as_bytes", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "2992": { - "qualifiedName": "stream_items", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "3011": { - "qualifiedName": "push_items", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "3015": { - "qualifiedName": "get_statistics", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "3018": { - "qualifiedName": "create_items_public_url", - "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" - }, - "3033": { - "qualifiedName": "RunClient", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3034": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3039": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3042": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3048": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3051": { - "qualifiedName": "abort", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3055": { - "qualifiedName": "wait_for_finish", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3059": { - "qualifiedName": "metamorph", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3066": { - "qualifiedName": "resurrect", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3075": { - "qualifiedName": "reboot", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3078": { - "qualifiedName": "dataset", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3080": { - "qualifiedName": "key_value_store", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3082": { - "qualifiedName": "request_queue", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3084": { - "qualifiedName": "log", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3086": { - "qualifiedName": "get_streamed_log", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3091": { - "qualifiedName": "charge", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3097": { - "qualifiedName": "get_status_message_watcher", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3102": { - "qualifiedName": "RunClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3103": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3108": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3111": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3117": { - "qualifiedName": "abort", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3121": { - "qualifiedName": "wait_for_finish", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3125": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3128": { - "qualifiedName": "metamorph", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3135": { - "qualifiedName": "resurrect", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3144": { - "qualifiedName": "reboot", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3147": { - "qualifiedName": "dataset", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3149": { - "qualifiedName": "key_value_store", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3151": { - "qualifiedName": "request_queue", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3153": { - "qualifiedName": "log", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3155": { - "qualifiedName": "get_streamed_log", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3160": { - "qualifiedName": "charge", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3166": { - "qualifiedName": "get_status_message_watcher", - "sourceFileName": "/src/apify_client/_resource_clients/run.py" - }, - "3171": { - "qualifiedName": "BuildClient", - "sourceFileName": "/src/apify_client/_resource_clients/build.py" - }, - "3172": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/build.py" - }, - "3177": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/build.py" - }, - "3180": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/build.py" - }, - "3183": { - "qualifiedName": "abort", - "sourceFileName": "/src/apify_client/_resource_clients/build.py" - }, - "3186": { - "qualifiedName": "get_open_api_definition", - "sourceFileName": "/src/apify_client/_resource_clients/build.py" - }, - "3189": { - "qualifiedName": "wait_for_finish", - "sourceFileName": "/src/apify_client/_resource_clients/build.py" - }, - "3193": { - "qualifiedName": "log", - "sourceFileName": "/src/apify_client/_resource_clients/build.py" - }, - "3195": { - "qualifiedName": "BuildClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/build.py" - }, - "3196": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/build.py" - }, - "3201": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/build.py" - }, - "3204": { - "qualifiedName": "abort", - "sourceFileName": "/src/apify_client/_resource_clients/build.py" - }, - "3207": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/build.py" - }, - "3210": { - "qualifiedName": "get_open_api_definition", - "sourceFileName": "/src/apify_client/_resource_clients/build.py" - }, - "3213": { - "qualifiedName": "wait_for_finish", - "sourceFileName": "/src/apify_client/_resource_clients/build.py" - }, - "3217": { - "qualifiedName": "log", - "sourceFileName": "/src/apify_client/_resource_clients/build.py" - }, - "3219": { - "qualifiedName": "ScheduleCollectionClient", - "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" - }, - "3220": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" - }, - "3224": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" - }, - "3230": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" - }, - "3236": { - "qualifiedName": "create", - "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" - }, - "3247": { - "qualifiedName": "ScheduleCollectionClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" - }, - "3248": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" - }, - "3252": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" - }, - "3258": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" - }, - "3264": { - "qualifiedName": "create", - "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" - }, - "3275": { - "qualifiedName": "ActorVersionCollectionClient", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" - }, - "3276": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" - }, - "3280": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" - }, - "3283": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" - }, - "3286": { - "qualifiedName": "create", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" - }, - "3298": { - "qualifiedName": "ActorVersionCollectionClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" - }, - "3299": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" - }, - "3303": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" - }, - "3306": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" - }, - "3309": { - "qualifiedName": "create", - "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" - }, - "3321": { - "qualifiedName": "DatasetCollectionClient", - "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" - }, - "3322": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" - }, - "3326": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" - }, - "3334": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" - }, - "3342": { - "qualifiedName": "get_or_create", - "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" - }, - "3347": { - "qualifiedName": "DatasetCollectionClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" - }, - "3348": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" - }, - "3352": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" - }, - "3360": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" - }, - "3368": { - "qualifiedName": "get_or_create", - "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" - }, - "3373": { - "qualifiedName": "ResourceClientBase", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3374": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3383": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3384": { - "qualifiedName": "ResourceClient", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3385": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3394": { - "qualifiedName": "ResourceClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3395": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3404": { - "qualifiedName": "ActorClient", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3405": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3410": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3413": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3441": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3444": { - "qualifiedName": "start", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3458": { - "qualifiedName": "call", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3473": { - "qualifiedName": "build", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3481": { - "qualifiedName": "builds", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3483": { - "qualifiedName": "runs", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3485": { - "qualifiedName": "default_build", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3489": { - "qualifiedName": "last_run", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3493": { - "qualifiedName": "versions", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3495": { - "qualifiedName": "version", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3498": { - "qualifiedName": "webhooks", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3500": { - "qualifiedName": "validate_input", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3506": { - "qualifiedName": "ActorClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3507": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3512": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3515": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3543": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3546": { - "qualifiedName": "start", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3560": { - "qualifiedName": "call", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3575": { - "qualifiedName": "build", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3583": { - "qualifiedName": "builds", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3585": { - "qualifiedName": "runs", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3587": { - "qualifiedName": "default_build", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3591": { - "qualifiedName": "last_run", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3595": { - "qualifiedName": "versions", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3597": { - "qualifiedName": "version", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3600": { - "qualifiedName": "webhooks", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3602": { - "qualifiedName": "validate_input", - "sourceFileName": "/src/apify_client/_resource_clients/actor.py" - }, - "3608": { - "qualifiedName": "KeyValueStoreClient", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3609": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3614": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3617": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3622": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3625": { - "qualifiedName": "list_keys", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3633": { - "qualifiedName": "iterate_keys", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3642": { - "qualifiedName": "get_record", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3647": { - "qualifiedName": "record_exists", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3651": { - "qualifiedName": "get_record_as_bytes", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3656": { - "qualifiedName": "stream_record", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3661": { - "qualifiedName": "set_record", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3667": { - "qualifiedName": "delete_record", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3671": { - "qualifiedName": "get_record_public_url", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3675": { - "qualifiedName": "create_keys_public_url", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3683": { - "qualifiedName": "KeyValueStoreClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3684": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3689": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3692": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3697": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3700": { - "qualifiedName": "list_keys", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3708": { - "qualifiedName": "iterate_keys", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3717": { - "qualifiedName": "get_record", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3722": { - "qualifiedName": "record_exists", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3726": { - "qualifiedName": "get_record_as_bytes", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3731": { - "qualifiedName": "stream_record", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3736": { - "qualifiedName": "set_record", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3742": { - "qualifiedName": "delete_record", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3746": { - "qualifiedName": "get_record_public_url", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3750": { - "qualifiedName": "create_keys_public_url", - "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" - }, - "3758": { - "qualifiedName": "ActorEnvVarClient", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" - }, - "3759": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" - }, - "3764": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" - }, - "3767": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" - }, - "3773": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" - }, - "3776": { - "qualifiedName": "ActorEnvVarClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" - }, - "3777": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" - }, - "3782": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" - }, - "3785": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" - }, - "3791": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" - }, - "3794": { - "qualifiedName": "WebhookCollectionClient", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" - }, - "3795": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" - }, - "3799": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" - }, - "3805": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" - }, - "3811": { - "qualifiedName": "create", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" - }, - "3825": { - "qualifiedName": "WebhookCollectionClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" - }, - "3826": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" - }, - "3830": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" - }, - "3836": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" - }, - "3842": { - "qualifiedName": "create", - "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" - }, - "3856": { - "qualifiedName": "WebhookClient", - "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" - }, - "3857": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" - }, - "3862": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" - }, - "3865": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" - }, - "3878": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" - }, - "3881": { - "qualifiedName": "test", - "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" - }, - "3884": { - "qualifiedName": "dispatches", - "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" - }, - "3886": { - "qualifiedName": "WebhookClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" - }, - "3887": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" - }, - "3892": { - "qualifiedName": "get", - "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" - }, - "3895": { - "qualifiedName": "update", - "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" - }, - "3908": { - "qualifiedName": "delete", - "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" - }, - "3911": { - "qualifiedName": "test", - "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" - }, - "3914": { - "qualifiedName": "dispatches", - "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" - }, - "3916": { - "qualifiedName": "RunCollectionClient", - "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py" - }, - "3917": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py" - }, - "3921": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py" - }, - "3930": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py" - }, - "3939": { - "qualifiedName": "RunCollectionClientAsync", - "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py" - }, - "3940": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py" - }, - "3944": { - "qualifiedName": "list", - "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py" - }, - "3953": { - "qualifiedName": "iterate", - "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py" - }, - "3962": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3963": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3964": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3965": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3966": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3967": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3968": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3969": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3970": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3971": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3972": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3973": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3974": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3975": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3976": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3977": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3978": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3979": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3980": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3981": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3982": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3983": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3984": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3985": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3986": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3987": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3988": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3989": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3990": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3991": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3992": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3993": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3994": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3995": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3996": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3997": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3998": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "3999": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4000": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4001": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4002": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4003": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4004": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4005": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4006": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4007": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4008": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4009": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4010": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4011": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4012": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4013": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4014": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4015": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4016": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4017": { - "qualifiedName": "resource_id", - "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" - }, - "4018": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "4019": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/http_clients/_base.py" - }, - "4020": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4021": { - "qualifiedName": "data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4022": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4023": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4024": { - "qualifiedName": "general_access", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4025": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4026": { - "qualifiedName": "user_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4027": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4028": { - "qualifiedName": "cron_expression", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4029": { - "qualifiedName": "timezone", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4030": { - "qualifiedName": "is_enabled", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4031": { - "qualifiedName": "is_exclusive", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4032": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4033": { - "qualifiedName": "modified_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4034": { - "qualifiedName": "next_run_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4035": { - "qualifiedName": "last_run_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4036": { - "qualifiedName": "id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4037": { - "qualifiedName": "user_id", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4038": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4039": { - "qualifiedName": "cron_expression", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4040": { - "qualifiedName": "timezone", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4041": { - "qualifiedName": "is_enabled", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4042": { - "qualifiedName": "is_exclusive", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4043": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4044": { - "qualifiedName": "modified_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4045": { - "qualifiedName": "next_run_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4046": { - "qualifiedName": "last_run_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4047": { - "qualifiedName": "message", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4048": { - "qualifiedName": "message", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4049": { - "qualifiedName": "message", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4050": { - "qualifiedName": "unique_key", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4051": { - "qualifiedName": "url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4052": { - "qualifiedName": "method", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4053": { - "qualifiedName": "retry_count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4054": { - "qualifiedName": "loaded_url", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4055": { - "qualifiedName": "payload", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4056": { - "qualifiedName": "headers", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4057": { - "qualifiedName": "user_data", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4058": { - "qualifiedName": "no_retry", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4059": { - "qualifiedName": "error_messages", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4060": { - "qualifiedName": "handled_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4061": { - "qualifiedName": "total", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4062": { - "qualifiedName": "offset", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4063": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4064": { - "qualifiedName": "desc", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4065": { - "qualifiedName": "count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4066": { - "qualifiedName": "total", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4067": { - "qualifiedName": "offset", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4068": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4069": { - "qualifiedName": "desc", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4070": { - "qualifiedName": "count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4071": { - "qualifiedName": "total", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4072": { - "qualifiedName": "offset", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4073": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4074": { - "qualifiedName": "desc", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4075": { - "qualifiedName": "count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4076": { - "qualifiedName": "total", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4077": { - "qualifiedName": "offset", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4078": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4079": { - "qualifiedName": "desc", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4080": { - "qualifiedName": "count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4081": { - "qualifiedName": "total", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4082": { - "qualifiedName": "offset", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4083": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4084": { - "qualifiedName": "desc", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4085": { - "qualifiedName": "count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4086": { - "qualifiedName": "total", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4087": { - "qualifiedName": "offset", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4088": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4089": { - "qualifiedName": "desc", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4090": { - "qualifiedName": "count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4091": { - "qualifiedName": "total", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4092": { - "qualifiedName": "offset", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4093": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4094": { - "qualifiedName": "desc", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4095": { - "qualifiedName": "count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4096": { - "qualifiedName": "total", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4097": { - "qualifiedName": "offset", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4098": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4099": { - "qualifiedName": "desc", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4100": { - "qualifiedName": "count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4101": { - "qualifiedName": "total", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4102": { - "qualifiedName": "offset", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4103": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4104": { - "qualifiedName": "desc", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4105": { - "qualifiedName": "count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4106": { - "qualifiedName": "total", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4107": { - "qualifiedName": "offset", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4108": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4109": { - "qualifiedName": "desc", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4110": { - "qualifiedName": "count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4111": { - "qualifiedName": "total", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4112": { - "qualifiedName": "offset", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4113": { - "qualifiedName": "limit", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4114": { - "qualifiedName": "desc", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4115": { - "qualifiedName": "count", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4116": { - "qualifiedName": "apify_margin_percentage", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4117": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4118": { - "qualifiedName": "started_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4119": { - "qualifiedName": "notified_about_future_change_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4120": { - "qualifiedName": "notified_about_change_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4121": { - "qualifiedName": "reason_for_change", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4122": { - "qualifiedName": "apify_margin_percentage", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4123": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4124": { - "qualifiedName": "started_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4125": { - "qualifiedName": "notified_about_future_change_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4126": { - "qualifiedName": "notified_about_change_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4127": { - "qualifiedName": "reason_for_change", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4128": { - "qualifiedName": "apify_margin_percentage", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4129": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4130": { - "qualifiedName": "started_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4131": { - "qualifiedName": "notified_about_future_change_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4132": { - "qualifiedName": "notified_about_change_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4133": { - "qualifiedName": "reason_for_change", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4134": { - "qualifiedName": "apify_margin_percentage", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4135": { - "qualifiedName": "created_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4136": { - "qualifiedName": "started_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4137": { - "qualifiedName": "notified_about_future_change_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4138": { - "qualifiedName": "notified_about_change_at", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4139": { - "qualifiedName": "reason_for_change", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4140": { - "qualifiedName": "name", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4141": { - "qualifiedName": "value", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4142": { - "qualifiedName": "is_secret", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4143": { - "qualifiedName": "model_config", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4144": { - "qualifiedName": "encoded", - "sourceFileName": "/src/apify_client/_models.py" - }, - "4145": { - "qualifiedName": "uniqueKey", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4146": { - "qualifiedName": "url", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4147": { - "qualifiedName": "method", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4148": { - "qualifiedName": "retryCount", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4149": { - "qualifiedName": "loadedUrl", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4150": { - "qualifiedName": "payload", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4151": { - "qualifiedName": "headers", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4152": { - "qualifiedName": "userData", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4153": { - "qualifiedName": "noRetry", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4154": { - "qualifiedName": "errorMessages", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4155": { - "qualifiedName": "handledAt", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4156": { - "qualifiedName": "unique_key", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4157": { - "qualifiedName": "url", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4158": { - "qualifiedName": "method", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4159": { - "qualifiedName": "retry_count", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4160": { - "qualifiedName": "loaded_url", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4161": { - "qualifiedName": "payload", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4162": { - "qualifiedName": "headers", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4163": { - "qualifiedName": "user_data", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4164": { - "qualifiedName": "no_retry", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4165": { - "qualifiedName": "error_messages", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4166": { - "qualifiedName": "handled_at", - "sourceFileName": "/src/apify_client/_typeddicts.py" - }, - "4167": { - "qualifiedName": "__new__", - "sourceFileName": "/src/apify_client/errors.py" - }, - "4168": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/errors.py" - }, - "4169": { - "qualifiedName": "__new__", - "sourceFileName": "/src/apify_client/errors.py" - }, - "4170": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/errors.py" - }, - "4171": { - "qualifiedName": "__new__", - "sourceFileName": "/src/apify_client/errors.py" - }, - "4172": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/errors.py" - }, - "4173": { - "qualifiedName": "__new__", - "sourceFileName": "/src/apify_client/errors.py" - }, - "4174": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/errors.py" - }, - "4175": { - "qualifiedName": "__new__", - "sourceFileName": "/src/apify_client/errors.py" - }, - "4176": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/errors.py" - }, - "4177": { - "qualifiedName": "__new__", - "sourceFileName": "/src/apify_client/errors.py" - }, - "4178": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/errors.py" - }, - "4179": { - "qualifiedName": "__new__", - "sourceFileName": "/src/apify_client/errors.py" - }, - "4180": { - "qualifiedName": "__init__", - "sourceFileName": "/src/apify_client/errors.py" - } - }, - "overloads": [ - { - "args": [ - { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", - "lineno": 34 + "type": "literal", + "value": "'ACTOR.BUILD.FAILED'" }, - "name": "td", - "type": "POSITIONAL", - "datatype": "None" + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 309, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L309" + } + ] }, { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", - "lineno": 34 + "id": 1849, + "name": "ACTOR_BUILD_TIMED_OUT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Triggered when an Actor build process exceeds the time limit." + } + ] }, - "name": "as_int", - "type": "KEYWORD_ONLY", - "datatype": "bool", - "default_value": "..." - } - ], - "return_type": "None", - "decorations": [ + "type": { + "type": "literal", + "value": "'ACTOR.BUILD.TIMED_OUT'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 312, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L312" + } + ] + }, { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", - "lineno": 33 + "id": 1850, + "name": "ACTOR_BUILD_ABORTED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Triggered when an Actor build is manually cancelled by user." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR.BUILD.ABORTED'" }, - "name": "overload" + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 315, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L315" + } + ] } ], - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", - "lineno": 34 - }, - "name": "to_seconds", - "type": "function", - "parsedDocstring": { - "text": "" - } - }, - { - "args": [ + "groups": [ { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", - "lineno": 36 - }, - "name": "td", - "type": "POSITIONAL", - "datatype": "timedelta" + "title": "Enumeration Members", + "children": [ + 1850, + 1846, + 1848, + 1847, + 1849, + 1844, + 1840, + 1842, + 1845, + 1841, + 1843 + ] } ], - "return_type": "float", - "decorations": [ + "sources": [ { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", - "lineno": 35 - }, - "name": "overload" + "filename": "/src/apify_shared/consts.py", + "line": 277, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L277" } - ], - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", - "lineno": 36 - }, - "name": "to_seconds", - "type": "function", - "parsedDocstring": { - "text": "" - } + ] }, { - "args": [ + "id": 1851, + "name": "MetaOrigin", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Origins indicating how Actor runs were initiated.\n\nThis information helps track and analyze how Actors are being used\nacross different interfaces and automation systems on the platform." + } + ] + }, + "children": [ { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", - "lineno": 38 + "id": 1852, + "name": "DEVELOPMENT", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor run started from the Developer Console source code section." + } + ] + }, + "type": { + "type": "literal", + "value": "'DEVELOPMENT'" }, - "name": "td", - "type": "POSITIONAL", - "datatype": "timedelta" + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 326, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L326" + } + ] }, { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", - "lineno": 38 + "id": 1853, + "name": "WEB", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor run initiated through the Apify Console web interface." + } + ] }, - "name": "as_int", - "type": "KEYWORD_ONLY", - "datatype": "Literal[True]" - } - ], - "return_type": "int", - "decorations": [ - { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", - "lineno": 37 + "type": { + "type": "literal", + "value": "'WEB'" }, - "name": "overload" - } - ], - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", - "lineno": 38 - }, - "name": "to_seconds", - "type": "function", - "parsedDocstring": { - "text": "" - } - }, - { - "args": [ + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 329, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L329" + } + ] + }, { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", - "lineno": 40 + "id": 1854, + "name": "API", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor run started programmatically via the Apify API." + } + ] }, - "name": "td", - "type": "POSITIONAL", - "datatype": "timedelta" + "type": { + "type": "literal", + "value": "'API'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 332, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L332" + } + ] }, { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", - "lineno": 40 + "id": 1855, + "name": "SCHEDULER", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor run triggered automatically by a scheduled task." + } + ] }, - "name": "as_int", - "type": "KEYWORD_ONLY", - "datatype": "Literal[False]" - } - ], - "return_type": "float", - "decorations": [ + "type": { + "type": "literal", + "value": "'SCHEDULER'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 335, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L335" + } + ] + }, { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", - "lineno": 39 + "id": 1856, + "name": "TEST", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor run initiated from the test/try functionality in Console." + } + ] }, - "name": "overload" - } - ], - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", - "lineno": 40 - }, - "name": "to_seconds", - "type": "function", - "parsedDocstring": { - "text": "" - } - }, - { - "args": [ + "type": { + "type": "literal", + "value": "'TEST'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 338, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L338" + } + ] + }, { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 103 + "id": 1857, + "name": "WEBHOOK", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor run triggered by an incoming webhook request." + } + ] }, - "name": "callback", - "type": "POSITIONAL", - "datatype": "Callable[..., ListOfKeys]" + "type": { + "type": "literal", + "value": "'WEBHOOK'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 341, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L341" + } + ] }, { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 105 + "id": 1858, + "name": "ACTOR", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor run started by another Actor during its execution." + } + ] + }, + "type": { + "type": "literal", + "value": "'ACTOR'" }, - "name": "cursor", - "type": "KEYWORD_ONLY", - "datatype": "str | None", - "default_value": "None" + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 344, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L344" + } + ] }, { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 106 + "id": 1859, + "name": "STANDBY", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor run initiated through the Actor Standby mode." + } + ] }, - "name": "limit", - "type": "KEYWORD_ONLY", - "datatype": "int | None", - "default_value": "None" + "type": { + "type": "literal", + "value": "'STANDBY'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 347, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L347" + } + ] }, { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 107 + "id": 1860, + "name": "CLI", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor run started using the Apify command-line interface." + } + ] }, - "name": "chunk_size", - "type": "KEYWORD_ONLY", - "datatype": "int | None", - "default_value": "None" + "type": { + "type": "literal", + "value": "'CLI'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 350, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L350" + } + ] } ], - "return_type": "Iterator[KeyValueStoreKey]", - "decorations": [ + "groups": [ { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 101 - }, - "name": "overload" + "title": "Enumeration Members", + "children": [ + 1858, + 1854, + 1860, + 1852, + 1855, + 1859, + 1856, + 1853, + 1857 + ] } ], - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 102 - }, - "name": "get_cursor_iterator", - "type": "function", - "parsedDocstring": { - "text": "" - } + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 319, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L319" + } + ] }, { - "args": [ + "id": 1861, + "name": "StorageGeneralAccess", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Storage setting determining how others can access the storage.\n\nThis setting overrides the user setting of the storage owner." + } + ] + }, + "children": [ { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 111 + "id": 1862, + "name": "FOLLOW_USER_SETTING", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Respect the user setting of the storage owner (default behavior)." + } + ] }, - "name": "callback", - "type": "POSITIONAL", - "datatype": "Callable[..., ListOfRequests]" + "type": { + "type": "literal", + "value": "'FOLLOW_USER_SETTING'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 360, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L360" + } + ] }, { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 113 + "id": 1863, + "name": "RESTRICTED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Only signed-in users with explicit access can read this storage." + } + ] + }, + "type": { + "type": "literal", + "value": "'RESTRICTED'" }, - "name": "cursor", - "type": "KEYWORD_ONLY", - "datatype": "str | None", - "default_value": "None" + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 363, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L363" + } + ] }, { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 114 + "id": 1864, + "name": "ANYONE_WITH_ID_CAN_READ", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Anyone with a link or the unique storage ID can read this storage." + } + ] }, - "name": "limit", - "type": "KEYWORD_ONLY", - "datatype": "int | None", - "default_value": "None" + "type": { + "type": "literal", + "value": "'ANYONE_WITH_ID_CAN_READ'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 366, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L366" + } + ] }, { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 115 + "id": 1865, + "name": "ANYONE_WITH_NAME_CAN_READ", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Anyone with a link, ID, or storage name can read this storage." + } + ] }, - "name": "chunk_size", - "type": "KEYWORD_ONLY", - "datatype": "int | None", - "default_value": "None" + "type": { + "type": "literal", + "value": "'ANYONE_WITH_NAME_CAN_READ'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 369, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L369" + } + ] } ], - "return_type": "Iterator[Request]", - "decorations": [ + "groups": [ { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 109 - }, - "name": "overload" + "title": "Enumeration Members", + "children": [ + 1864, + 1865, + 1862, + 1863 + ] } ], - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 110 - }, - "name": "get_cursor_iterator", - "type": "function", - "parsedDocstring": { - "text": "" - } + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 354, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L354" + } + ] }, { - "args": [ + "id": 1866, + "name": "RunGeneralAccess", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Run setting determining how others can access the run.\n\nThis setting overrides the user setting of the run owner." + } + ] + }, + "children": [ { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 158 + "id": 1867, + "name": "FOLLOW_USER_SETTING", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Respect the user setting of the storage owner (default behavior)." + } + ] }, - "name": "callback", - "type": "POSITIONAL", - "datatype": "Callable[..., Awaitable[ListOfKeys]]" - }, - { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 160 + "type": { + "type": "literal", + "value": "'FOLLOW_USER_SETTING'" }, - "name": "cursor", - "type": "KEYWORD_ONLY", - "datatype": "str | None", - "default_value": "None" + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 379, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L379" + } + ] }, { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 161 + "id": 1868, + "name": "RESTRICTED", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Only signed-in users with explicit access can read this run." + } + ] }, - "name": "limit", - "type": "KEYWORD_ONLY", - "datatype": "int | None", - "default_value": "None" + "type": { + "type": "literal", + "value": "'RESTRICTED'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 382, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L382" + } + ] }, { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 162 + "id": 1869, + "name": "ANYONE_WITH_ID_CAN_READ", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Anyone with a link or the unique run ID can read this run." + } + ] }, - "name": "chunk_size", - "type": "KEYWORD_ONLY", - "datatype": "int | None", - "default_value": "None" + "type": { + "type": "literal", + "value": "'ANYONE_WITH_ID_CAN_READ'" + }, + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 385, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L385" + } + ] } ], - "return_type": "AsyncIterator[KeyValueStoreKey]", - "decorations": [ + "groups": [ { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 156 - }, - "name": "overload" + "title": "Enumeration Members", + "children": [ + 1869, + 1867, + 1868 + ] } ], - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 157 - }, - "name": "get_cursor_iterator_async", - "type": "function", - "parsedDocstring": { - "text": "" - } + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 373, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L373" + } + ] }, { - "args": [ + "id": 1870, + "name": "ActorPermissionLevel", + "module": "apify_shared.consts", + "kind": 8, + "kindString": "Enumeration", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Determines permissions that the Actor is granted when running.\n\nBased on this value, the Apify platform generates a scoped run token with a corresponding permission scope and\ninjects it into the Actor runtime.\n\nWarning: Make sure you know what you are doing when changing this value!" + } + ] + }, + "children": [ { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 166 + "id": 1871, + "name": "FULL_PERMISSIONS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Full permission Actors have access to all user data in the account." + } + ] }, - "name": "callback", - "type": "POSITIONAL", - "datatype": "Callable[..., Awaitable[ListOfRequests]]" - }, - { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 168 + "type": { + "type": "literal", + "value": "'FULL_PERMISSIONS'" }, - "name": "cursor", - "type": "KEYWORD_ONLY", - "datatype": "str | None", - "default_value": "None" + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 398, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L398" + } + ] }, { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 169 + "id": 1872, + "name": "LIMITED_PERMISSIONS", + "module": "apify_shared.consts", + "kind": 16, + "kindString": "Enumeration Member", + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limited permission Actors have access only to specific resources:\n - default storages\n - storages provided via input\n - the current run\n - ...\n\nBroadly speaking, limited permission Actors cannot access any account data not related to the current run.\nFor details refer to the Apify documentation." + } + ] }, - "name": "limit", - "type": "KEYWORD_ONLY", - "datatype": "int | None", - "default_value": "None" - }, - { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 170 + "type": { + "type": "literal", + "value": "'LIMITED_PERMISSIONS'" }, - "name": "chunk_size", - "type": "KEYWORD_ONLY", - "datatype": "int | None", - "default_value": "None" + "children": [], + "groups": [], + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 401, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L401" + } + ] } ], - "return_type": "AsyncIterator[Request]", - "decorations": [ + "groups": [ { - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 164 - }, - "name": "overload" + "title": "Enumeration Members", + "children": [ + 1871, + 1872 + ] } ], - "location": { - "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", - "lineno": 165 - }, - "name": "get_cursor_iterator_async", - "type": "function", - "parsedDocstring": { - "text": "" - } + "sources": [ + { + "filename": "/src/apify_shared/consts.py", + "line": 389, + "character": 1, + "url": "https://github.com/apify/apify-shared-python/blob/v2.2.0/src/apify_shared/consts.py#L389" + } + ] + } + ], + "groups": [ + { + "title": "Main Clients", + "children": [ + 1551, + 1620 + ] + }, + { + "title": "Resource Clients", + "children": [ + 1337, + 1242, + 1222, + 1201, + 1549, + 1161, + 1133, + 1531, + 1105, + 1093, + 892, + 870, + 772, + 750, + 662, + 542, + 521, + 1529, + 1527, + 415, + 397, + 363, + 331, + 311, + 205, + 145, + 123, + 81, + 30, + 24, + 12 + ] + }, + { + "title": "Async Resource Clients", + "children": [ + 1427, + 1275, + 1232, + 1209, + 1550, + 1181, + 1147, + 1540, + 1119, + 1099, + 1002, + 881, + 821, + 761, + 672, + 602, + 531, + 1530, + 1528, + 468, + 406, + 380, + 347, + 716, + 321, + 699, + 258, + 167, + 134, + 102, + 49, + 27, + 18 + ] + }, + { + "title": "Helper Classes", + "children": [ + 541, + 1517, + 1725, + 1745, + 1735, + 711, + 733, + 682, + 687 + ] + }, + { + "title": "Errors", + "children": [ + 2, + 1, + 8, + 1721 + ] + }, + { + "title": "Methods", + "children": [ + 1752, + 1742, + 1756, + 1749, + 1718, + 1689, + 1692, + 1217, + 1308, + 189, + 68, + 1700, + 1706, + 1703, + 1709, + 1712, + 1715, + 1696 + ] + }, + { + "title": "Properties", + "children": [ + 1724 + ] + }, + { + "title": "Constants", + "children": [ + 1782, + 1777, + 1836, + 1762, + 1870, + 1772, + 1805, + 1851, + 1866, + 1861, + 1839 + ] + } + ], + "sources": [ + { + "fileName": "src/index.ts", + "line": 1, + "character": 0, + "url": "http://example.com/blob/123456/src/dummy.py" } ] } \ No newline at end of file diff --git a/website/versioned_docs/version-3.0/01_introduction/code/01_usage_async.py b/website/versioned_docs/version-3.0/01_introduction/code/01_usage_async.py new file mode 100644 index 00000000..4a45b1e2 --- /dev/null +++ b/website/versioned_docs/version-3.0/01_introduction/code/01_usage_async.py @@ -0,0 +1,21 @@ +from apify_client import ApifyClientAsync + +# You can find your API token at https://console.apify.com/settings/integrations. +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + + # Start an Actor and wait for it to finish. + actor_client = apify_client.actor('john-doe/my-cool-actor') + call_result = await actor_client.call() + + if call_result is None: + print('Actor run failed.') + return + + # Fetch results from the Actor run's default dataset. + dataset_client = apify_client.dataset(call_result.default_dataset_id) + list_items_result = await dataset_client.list_items() + print(f'Dataset: {list_items_result}') diff --git a/website/versioned_docs/version-3.0/01_introduction/code/01_usage_sync.py b/website/versioned_docs/version-3.0/01_introduction/code/01_usage_sync.py new file mode 100644 index 00000000..84e430fa --- /dev/null +++ b/website/versioned_docs/version-3.0/01_introduction/code/01_usage_sync.py @@ -0,0 +1,21 @@ +from apify_client import ApifyClient + +# You can find your API token at https://console.apify.com/settings/integrations. +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + + # Start an Actor and wait for it to finish. + actor_client = apify_client.actor('john-doe/my-cool-actor') + call_result = actor_client.call() + + if call_result is None: + print('Actor run failed.') + return + + # Fetch results from the Actor run's default dataset. + dataset_client = apify_client.dataset(call_result.default_dataset_id) + list_items_result = dataset_client.list_items() + print(f'Dataset: {list_items_result}') diff --git a/website/versioned_docs/version-3.0/01_introduction/code/02_auth_async.py b/website/versioned_docs/version-3.0/01_introduction/code/02_auth_async.py new file mode 100644 index 00000000..a584ccba --- /dev/null +++ b/website/versioned_docs/version-3.0/01_introduction/code/02_auth_async.py @@ -0,0 +1,8 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + # Client initialization with the API token. + apify_client = ApifyClientAsync(TOKEN) diff --git a/website/versioned_docs/version-3.0/01_introduction/code/02_auth_sync.py b/website/versioned_docs/version-3.0/01_introduction/code/02_auth_sync.py new file mode 100644 index 00000000..a5f4de39 --- /dev/null +++ b/website/versioned_docs/version-3.0/01_introduction/code/02_auth_sync.py @@ -0,0 +1,8 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + # Client initialization with the API token. + apify_client = ApifyClient(TOKEN) diff --git a/website/versioned_docs/version-3.0/01_introduction/code/03_dataset_async.py b/website/versioned_docs/version-3.0/01_introduction/code/03_dataset_async.py new file mode 100644 index 00000000..99541d2a --- /dev/null +++ b/website/versioned_docs/version-3.0/01_introduction/code/03_dataset_async.py @@ -0,0 +1,11 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + dataset_client = apify_client.dataset('dataset-id') + + # Lists items from the Actor's dataset. + dataset_items = (await dataset_client.list_items()).items diff --git a/website/versioned_docs/version-3.0/01_introduction/code/03_dataset_sync.py b/website/versioned_docs/version-3.0/01_introduction/code/03_dataset_sync.py new file mode 100644 index 00000000..3cc7554d --- /dev/null +++ b/website/versioned_docs/version-3.0/01_introduction/code/03_dataset_sync.py @@ -0,0 +1,11 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + dataset_client = apify_client.dataset('dataset-id') + + # Lists items from the Actor's dataset. + dataset_items = dataset_client.list_items().items diff --git a/website/versioned_docs/version-3.0/01_introduction/code/03_input_async.py b/website/versioned_docs/version-3.0/01_introduction/code/03_input_async.py new file mode 100644 index 00000000..1937f446 --- /dev/null +++ b/website/versioned_docs/version-3.0/01_introduction/code/03_input_async.py @@ -0,0 +1,16 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + actor_client = apify_client.actor('username/actor-name') + + # Define the input for the Actor. + run_input = { + 'some': 'input', + } + + # Start an Actor and wait for it to finish. + call_result = await actor_client.call(run_input=run_input) diff --git a/website/versioned_docs/version-3.0/01_introduction/code/03_input_sync.py b/website/versioned_docs/version-3.0/01_introduction/code/03_input_sync.py new file mode 100644 index 00000000..6a27dd39 --- /dev/null +++ b/website/versioned_docs/version-3.0/01_introduction/code/03_input_sync.py @@ -0,0 +1,16 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + actor_client = apify_client.actor('username/actor-name') + + # Define the input for the Actor. + run_input = { + 'some': 'input', + } + + # Start an Actor and wait for it to finish. + call_result = actor_client.call(run_input=run_input) diff --git a/website/versioned_docs/version-3.0/01_introduction/index.mdx b/website/versioned_docs/version-3.0/01_introduction/index.mdx new file mode 100644 index 00000000..ab1ae5a7 --- /dev/null +++ b/website/versioned_docs/version-3.0/01_introduction/index.mdx @@ -0,0 +1,57 @@ +--- +id: introduction +title: Overview +slug: / +description: The official Python library to access the Apify API, with automatic retries, async support, and comprehensive API coverage. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import UsageAsyncExample from '!!raw-loader!./code/01_usage_async.py'; +import UsageSyncExample from '!!raw-loader!./code/01_usage_sync.py'; + +The Apify API client for Python is the official library to access the [Apify REST API](/api/v2) from your Python applications. It provides useful features like automatic retries and convenience functions that improve the experience of using the Apify API. + +The client simplifies interaction with the Apify platform by providing: + +- Intuitive methods for working with [Actors](/platform/actors), [datasets](/platform/storage/dataset), [key-value stores](/platform/storage/key-value-store), and other Apify resources +- Both synchronous and asynchronous interfaces for flexible integration +- Built-in [retries with exponential backoff](../02_concepts/05_retries.mdx) for failed requests +- Comprehensive API coverage with JSON encoding (UTF-8) for all requests and responses + +## Prerequisites + +`apify-client` requires Python 3.11 or higher. Python is available for download on the [official website](https://www.python.org/downloads/). Check your current Python version by running: + +```bash +python --version +``` + +## Installation + +The Apify client is available as the [`apify-client`](https://pypi.org/project/apify-client/) package on PyPI. + +```bash +pip install apify-client +``` + +## Quick example + +The following example shows how to run an Actor and retrieve its results: + + + + + {UsageAsyncExample} + + + + + {UsageSyncExample} + + + + +> You can find your API token in the [Integrations section](https://console.apify.com/account/integrations) of Apify Console. See the [Quick start guide](./quick-start.mdx) for more details on authentication. diff --git a/website/versioned_docs/version-3.0/01_introduction/quick-start.mdx b/website/versioned_docs/version-3.0/01_introduction/quick-start.mdx new file mode 100644 index 00000000..7083c16c --- /dev/null +++ b/website/versioned_docs/version-3.0/01_introduction/quick-start.mdx @@ -0,0 +1,107 @@ +--- +id: quick-start +title: Quick start +description: Get started with the Apify API client for Python by running an Actor and retrieving results from its dataset. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import ApiLink from '@theme/ApiLink'; + +import AuthAsyncExample from '!!raw-loader!./code/02_auth_async.py'; +import AuthSyncExample from '!!raw-loader!./code/02_auth_sync.py'; +import InputAsyncExample from '!!raw-loader!./code/03_input_async.py'; +import InputSyncExample from '!!raw-loader!./code/03_input_sync.py'; +import DatasetAsyncExample from '!!raw-loader!./code/03_dataset_async.py'; +import DatasetSyncExample from '!!raw-loader!./code/03_dataset_sync.py'; + +Learn how to authenticate, run Actors, and retrieve results using the Apify API client for Python. + +--- + +## Step 1: Authenticate the client + +To use the client, you need an [API token](https://docs.apify.com/platform/integrations/api#api-token). You can find your token under the [Integrations](https://console.apify.com/account/integrations) tab in Apify Console. Copy the token and initialize the client by providing it (`MY-APIFY-TOKEN`) as a parameter to the `ApifyClient` constructor. + + + + + {AuthAsyncExample} + + + + + {AuthSyncExample} + + + + +:::warning Secure access + +The API token is used to authorize your requests to the Apify API. You can be charged for the usage of the underlying services, so do not share your API token with untrusted parties or expose it on the client side of your applications. + +::: + +## Step 2: Run an Actor + +To start an Actor, call the `apify_client.actor()` method with the Actor's ID (e.g., `john-doe/my-cool-actor`). The Actor's ID is a combination of the Actor owner's username and the Actor name. You can run both your own Actors and Actors from [Apify Store](https://apify.com/store). + +To define the Actor's input, pass a dictionary to the `call()` method that matches the Actor's [input schema](https://docs.apify.com/platform/actors/development/actor-definition/input-schema). The input can include URLs to scrape, search terms, or other configuration data. + + + + + {InputAsyncExample} + + + + + {InputSyncExample} + + + + +## Step 3: Get results from the dataset + +To get the results from the dataset, call the `apify_client.dataset()` method with the dataset ID, then call `list_items()` to retrieve the data. You can get the dataset ID from the Actor's run dictionary (represented by `defaultDatasetId`). + + + + + {DatasetAsyncExample} + + + + + {DatasetSyncExample} + + + + +:::note Dataset access + +Running an Actor might take time, depending on the Actor's complexity and the amount of data it processes. If you want only to get data and have an immediate response, you should access the existing dataset of the finished [Actor run](https://docs.apify.com/platform/actors/running/runs-and-builds#runs). + +::: + +## Next steps + +### Concepts + +To learn more about how the client works, check out the Concepts section in the sidebar: + +- [Asyncio support](../02_concepts/01_async_support.mdx) - asynchronous programming with the client +- [Single and collection clients](../02_concepts/02_single_collection_clients.mdx) - resource clients and collection clients +- [Error handling](../02_concepts/04_error_handling.mdx) - automatic data extraction and error debugging +- [Retries](../02_concepts/05_retries.mdx) - automatic retries with exponential backoff +- [Pagination](../02_concepts/08_pagination.mdx) - iterating through large result sets + +### Guides + +For practical examples of common tasks, see the Guides section: + +- [Pass input to an Actor](../03_guides/01_passing_input_to_actor.mdx) +- [Retrieve Actor data](../03_guides/03_retrieve_actor_data.mdx) +- [Integrate with data libraries](../03_guides/04_integration_with_data_libraries.mdx) diff --git a/website/versioned_docs/version-3.0/02_concepts/01_async_support.mdx b/website/versioned_docs/version-3.0/02_concepts/01_async_support.mdx new file mode 100644 index 00000000..1d7efa13 --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/01_async_support.mdx @@ -0,0 +1,22 @@ +--- +id: asyncio-support +title: Asyncio support +description: Use the async client for non-blocking API calls with Python asyncio. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; +import ApiLink from '@theme/ApiLink'; + +import AsyncSupportExample from '!!raw-loader!./code/01_async_support.py'; + +The package provides an asynchronous version of the client, `ApifyClientAsync`, which allows you to interact with the Apify API using Python's standard async/await syntax. This enables you to perform non-blocking operations, see the Python [asyncio documentation](https://docs.python.org/3/library/asyncio-task.html) for more information. This is useful for applications that need to perform multiple API operations concurrently or integrate with other async frameworks. + +The following example shows how to run an Actor asynchronously and stream its logs while it is running: + + + {AsyncSupportExample} + + +For the full async client API, see the `ApifyClientAsync` reference. diff --git a/website/versioned_docs/version-3.0/02_concepts/02_single_collection_clients.mdx b/website/versioned_docs/version-3.0/02_concepts/02_single_collection_clients.mdx new file mode 100644 index 00000000..1cdadc50 --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/02_single_collection_clients.mdx @@ -0,0 +1,51 @@ +--- +id: single-and-collection-clients +title: Single and collection clients +description: Understand the two types of resource clients, single-resource and collection clients. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import ApiLink from '@theme/ApiLink'; + +import CollectionAsyncExample from '!!raw-loader!./code/02_collection_async.py'; +import CollectionSyncExample from '!!raw-loader!./code/02_collection_sync.py'; +import SingleAsyncExample from '!!raw-loader!./code/02_single_async.py'; +import SingleSyncExample from '!!raw-loader!./code/02_single_sync.py'; + +The Apify client provides two types of resource clients: single-resource clients for managing an individual resource, and collection clients for listing or creating resources. + +- `ActorClient` - Manages a single resource. +- `ActorCollectionClient` - Manages a collection of resources. + + + + + {CollectionAsyncExample} + + + + + {CollectionSyncExample} + + + + +The resource ID can be the resource's `id` or a combination of `username/resource-name`. + + + + + {SingleAsyncExample} + + + + + {SingleSyncExample} + + + + +By utilizing the appropriate collection or resource client, you can simplify how you interact with the Apify API. diff --git a/website/versioned_docs/version-3.0/02_concepts/03_nested_clients.mdx b/website/versioned_docs/version-3.0/02_concepts/03_nested_clients.mdx new file mode 100644 index 00000000..95e512d1 --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/03_nested_clients.mdx @@ -0,0 +1,31 @@ +--- +id: nested-clients +title: Nested clients +description: Access related resources directly through nested client methods. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import ApiLink from '@theme/ApiLink'; + +import NestedAsyncExample from '!!raw-loader!./code/03_nested_async.py'; +import NestedSyncExample from '!!raw-loader!./code/03_nested_sync.py'; + +Nested clients let you access related resources directly from a parent resource client, without manually constructing new client instances. + + + + + {NestedAsyncExample} + + + + + {NestedSyncExample} + + + + +This direct access to [Dataset](https://docs.apify.com/platform/storage/dataset) (and other storage resources) from the `RunClient` is especially convenient when used alongside the `ActorClient.last_run` method. diff --git a/website/versioned_docs/version-3.0/02_concepts/04_error_handling.mdx b/website/versioned_docs/version-3.0/02_concepts/04_error_handling.mdx new file mode 100644 index 00000000..5eb1b4d0 --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/04_error_handling.mdx @@ -0,0 +1,46 @@ +--- +id: error-handling +title: Error handling +description: Handle API errors with the ApifyApiError exception and automatic data parsing. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; +import ApiLink from '@theme/ApiLink'; + +import ErrorAsyncExample from '!!raw-loader!./code/04_error_async.py'; +import ErrorSyncExample from '!!raw-loader!./code/04_error_sync.py'; + +When you use the Apify client, it automatically extracts all relevant data from the endpoint and returns it in the expected format. Date strings, for instance, are seamlessly converted to Python `datetime.datetime` objects. If an error occurs, the client raises an `ApifyApiError`. This exception wraps the raw JSON errors returned by the API and provides additional context, making it easier to debug any issues that arise. + +## Error subclasses + +The Apify client provides dedicated error subclasses based on the HTTP status code of the failed response, so you can branch on error kind without inspecting `status_code` or `type`: + +| Status | Subclass | +|---|---| +| 400 | `InvalidRequestError` | +| 401 | `UnauthorizedError` | +| 403 | `ForbiddenError` | +| 404 | `NotFoundError` | +| 409 | `ConflictError` | +| 429 | `RateLimitError` | +| 5xx | `ServerError` | + +All subclasses inherit from `ApifyApiError`, so an existing `except ApifyApiError` handler still catches every API error. Catch a specific subclass when you want to react differently to, for example, a missing resource or a rate-limit: + + + + + {ErrorAsyncExample} + + + + + {ErrorSyncExample} + + + + +For a complete list of error classes, see the `ApifyApiError` reference. diff --git a/website/versioned_docs/version-3.0/02_concepts/05_retries.mdx b/website/versioned_docs/version-3.0/02_concepts/05_retries.mdx new file mode 100644 index 00000000..dfdf0917 --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/05_retries.mdx @@ -0,0 +1,45 @@ +--- +id: retries +title: Retries +description: Configure automatic retries with exponential backoff for failed requests. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import ApiLink from '@theme/ApiLink'; + +import RetriesAsyncExample from '!!raw-loader!./code/05_retries_async.py'; +import RetriesSyncExample from '!!raw-loader!./code/05_retries_sync.py'; + +The Apify client automatically retries requests that fail due to: + +- Network errors +- Internal errors in the Apify API (HTTP status codes 500 and above) +- Rate limit errors (HTTP status code 429) + +By default, the client retries a failed request up to 4 times. The retry intervals use an exponential backoff strategy: + +- The first retry occurs after approximately 500 milliseconds. +- The second retry occurs after approximately 1,000 milliseconds, and so on. + +You can customize this behavior using the following options in the `ApifyClient` constructor: + +- `max_retries`: Defines the maximum number of retry attempts. +- `min_delay_between_retries`: Sets the minimum delay between retries as a `timedelta`. + +Retries with exponential backoff help reduce the load on the server and increase the chances of a successful request. + + + + + {RetriesAsyncExample} + + + + + {RetriesSyncExample} + + + diff --git a/website/versioned_docs/version-3.0/02_concepts/06_logging.mdx b/website/versioned_docs/version-3.0/02_concepts/06_logging.mdx new file mode 100644 index 00000000..4b4e8ed5 --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/06_logging.mdx @@ -0,0 +1,34 @@ +--- +id: logging +title: Logging +description: Configure debug logging to inspect API requests and responses. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import LoggingConfigExample from '!!raw-loader!./code/06_logging_config.py'; +import LoggingFormatterExample from '!!raw-loader!./code/06_logging_formatter.py'; + +The library logs useful debug information to the `apify_client` logger whenever it sends requests to the Apify API. You can configure this logger to print debug information to the standard output by adding a handler: + + + {LoggingConfigExample} + + +The log records include additional properties, provided via the extra argument, which can be helpful for debugging. Some of these properties are: + +- `attempt` - Number of retry attempts for the request. +- `status_code` - HTTP status code of the response. +- `url` - URL of the API endpoint being called. +- `client_method` - Method name of the client that initiated the request. +- `resource_id` - Identifier of the resource being accessed. + +To display these additional properties in the log output, you need to use a custom log formatter. Here's a basic example: + + + {LoggingFormatterExample} + + +For more information on creating and using custom log formatters, refer to the official Python [logging documentation](https://docs.python.org/3/howto/logging.html#formatters). diff --git a/website/versioned_docs/version-3.0/02_concepts/07_convenience_methods.mdx b/website/versioned_docs/version-3.0/02_concepts/07_convenience_methods.mdx new file mode 100644 index 00000000..24a25593 --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/07_convenience_methods.mdx @@ -0,0 +1,42 @@ +--- +id: convenience-methods +title: Convenience methods +description: Use high-level methods for running Actors, waiting for results, and accessing data. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import ApiLink from '@theme/ApiLink'; + +import CallAsyncExample from '!!raw-loader!./code/07_call_async.py'; +import CallSyncExample from '!!raw-loader!./code/07_call_sync.py'; + +The Apify client provides several convenience methods to handle actions that the API alone cannot perform efficiently, such as waiting for an Actor run to finish without running into network timeouts. These methods simplify common tasks and enhance the usability of the client. + +- `ActorClient.call` - Starts an Actor and waits for it to finish, handling network timeouts internally. Waits indefinitely by default, or up to the specified `wait_duration`. +- `ActorClient.start` - Starts an Actor and immediately returns the Run object without waiting for it to finish. +- `RunClient.wait_for_finish` - Waits for an already-started run to reach a terminal status. + +Additionally, storage-related resources offer flexible options for data retrieval: + +- [Key-value store](https://docs.apify.com/platform/storage/key-value-store) records can be retrieved as objects, buffers, or streams. +- [Dataset](https://docs.apify.com/platform/storage/dataset) items can be fetched as individual objects, serialized data, or iterated asynchronously. + + + + + {CallAsyncExample} + + + + + {CallSyncExample} + + + + +:::tip +The `call()` method polls internally and may take a long time for long-running Actors. Use `start()` and `wait_for_finish()` separately if you need more control over the waiting behavior. +::: diff --git a/website/versioned_docs/version-3.0/02_concepts/08_pagination.mdx b/website/versioned_docs/version-3.0/02_concepts/08_pagination.mdx new file mode 100644 index 00000000..880f6c0c --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/08_pagination.mdx @@ -0,0 +1,83 @@ +--- +id: pagination +title: Pagination +description: Paginate through large result sets using page models or generator-based iteration. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import ApiLink from '@theme/ApiLink'; + +import PaginationAsyncExample from '!!raw-loader!./code/08_pagination_async.py'; +import PaginationSyncExample from '!!raw-loader!./code/08_pagination_sync.py'; +import IterateItemsAsyncExample from '!!raw-loader!./code/08_iterate_items_async.py'; +import IterateItemsSyncExample from '!!raw-loader!./code/08_iterate_items_sync.py'; +import IterateCollectionAsyncExample from '!!raw-loader!./code/08_iterate_collection_async.py'; +import IterateCollectionSyncExample from '!!raw-loader!./code/08_iterate_collection_sync.py'; + +Most methods named `list` or `list_something` in the Apify client return a page model — a [Pydantic](https://docs.pydantic.dev/latest/) model such as `ListOfActors`, `ListOfDatasets`, or `ListOfRequests`. Unstructured dataset items use the `DatasetItemsPage` dataclass instead. All page models share a consistent interface for working with paginated data and expose the following fields: + +- `items` - The main results you're looking for. +- `total` - The total number of items available. +- `offset` - The starting point of the current page. +- `count` - The number of items in the current page. +- `limit` - The maximum number of items per page. + +Some methods, such as `list_keys` or `list_head`, paginate differently. Regardless, the primary results are always stored under the `items` field, and the `limit` field can be used to control the number of results returned. + +The following example shows how to fetch all items from a dataset using pagination: + + + + + {PaginationAsyncExample} + + + + + {PaginationSyncExample} + + + + +The page model interface offers several key benefits. Its consistent structure ensures predictable results for most `list` methods, providing a uniform way to work with paginated data. It also offers flexibility, allowing you to customize the `limit` and `offset` parameters to control data fetching according to your needs. Additionally, it provides scalability, enabling you to efficiently handle large datasets through pagination. This approach ensures efficient data retrieval while keeping memory usage under control, making it ideal for managing and processing large collections. + +## Generator-based iteration + +For collection clients, the `iterate` method returns an iterator that lazily fetches as many pages as needed +to retrieve every item matching the filters. For dataset, key-value store and request queue clients, the +matching helpers are `iterate_items`, `iterate_keys` and `iterate_requests`. They handle pagination +automatically, so you don't need to manage offsets, limits or cursors yourself. + +The example below iterates over every Actor owned by the current user using a collection client's `iterate` +method: + + + + + {IterateCollectionAsyncExample} + + + + + {IterateCollectionSyncExample} + + + + +The next example uses `iterate_items` on a dataset client to stream items past a given offset: + + + + + {IterateItemsAsyncExample} + + + + + {IterateItemsSyncExample} + + + diff --git a/website/versioned_docs/version-3.0/02_concepts/09_streaming.mdx b/website/versioned_docs/version-3.0/02_concepts/09_streaming.mdx new file mode 100644 index 00000000..53ea1fcf --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/09_streaming.mdx @@ -0,0 +1,41 @@ +--- +id: streaming-resources +title: Streaming resources +description: Stream large datasets, key-value store records, and logs without loading them into memory. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import ApiLink from '@theme/ApiLink'; + +import StreamingAsyncExample from '!!raw-loader!./code/09_streaming_async.py'; +import StreamingSyncExample from '!!raw-loader!./code/09_streaming_sync.py'; + +Certain resources, such as dataset items, key-value store records, and logs, support streaming directly from the Apify API. This allows you to process large resources incrementally without downloading them entirely into memory, making it ideal for handling large or continuously updated data. + +Supported streaming methods: + +- `DatasetClient.stream_items` - Stream dataset items incrementally. +- `KeyValueStoreClient.stream_record` - Stream key-value store records as raw data. +- `LogClient.stream` - Stream logs in real time. + +These methods return a raw, context-managed `impit.Response` object. The response must be consumed within a with block to ensure that the connection is closed automatically, preventing memory leaks or unclosed connections. + +The following example shows how to stream the logs of an Actor run incrementally: + + + + + {StreamingAsyncExample} + + + + + {StreamingSyncExample} + + + + +Streaming is ideal for processing large logs, datasets, or files incrementally without downloading them entirely into memory. diff --git a/website/versioned_docs/version-2.5/02_concepts/10_custom_http_clients.mdx b/website/versioned_docs/version-3.0/02_concepts/10_custom_http_clients.mdx similarity index 100% rename from website/versioned_docs/version-2.5/02_concepts/10_custom_http_clients.mdx rename to website/versioned_docs/version-3.0/02_concepts/10_custom_http_clients.mdx diff --git a/website/versioned_docs/version-2.5/02_concepts/11_timeouts.mdx b/website/versioned_docs/version-3.0/02_concepts/11_timeouts.mdx similarity index 100% rename from website/versioned_docs/version-2.5/02_concepts/11_timeouts.mdx rename to website/versioned_docs/version-3.0/02_concepts/11_timeouts.mdx diff --git a/website/versioned_docs/version-2.5/02_concepts/12_typed_models.mdx b/website/versioned_docs/version-3.0/02_concepts/12_typed_models.mdx similarity index 100% rename from website/versioned_docs/version-2.5/02_concepts/12_typed_models.mdx rename to website/versioned_docs/version-3.0/02_concepts/12_typed_models.mdx diff --git a/website/versioned_docs/version-3.0/02_concepts/code/01_async_support.py b/website/versioned_docs/version-3.0/02_concepts/code/01_async_support.py new file mode 100644 index 00000000..e8fe81b0 --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/01_async_support.py @@ -0,0 +1,25 @@ +import asyncio + +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + actor_client = apify_client.actor('my-actor-id') + + # Start the Actor and get the run ID + run_result = await actor_client.start() + run_client = apify_client.run(run_result.id) + log_client = run_client.log() + + # Stream the logs + async with log_client.stream() as async_log_stream: + if async_log_stream: + async for bytes_chunk in async_log_stream.aiter_bytes(): + print(bytes_chunk) + + +if __name__ == '__main__': + asyncio.run(main()) diff --git a/website/versioned_docs/version-3.0/02_concepts/code/02_collection_async.py b/website/versioned_docs/version-3.0/02_concepts/code/02_collection_async.py new file mode 100644 index 00000000..85ed3290 --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/02_collection_async.py @@ -0,0 +1,16 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + + # Collection clients do not require a parameter + actor_collection_client = apify_client.actors() + + # Create an Actor with the name: my-actor + my_actor = await actor_collection_client.create(name='my-actor') + + # List all of your Actors + actor_list = (await actor_collection_client.list()).items diff --git a/website/versioned_docs/version-3.0/02_concepts/code/02_collection_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/02_collection_sync.py new file mode 100644 index 00000000..988e41e7 --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/02_collection_sync.py @@ -0,0 +1,16 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + + # Collection clients do not require a parameter + actor_collection_client = apify_client.actors() + + # Create an Actor with the name: my-actor + my_actor = actor_collection_client.create(name='my-actor') + + # List all of your Actors + actor_list = actor_collection_client.list().items diff --git a/website/versioned_docs/version-3.0/02_concepts/code/02_single_async.py b/website/versioned_docs/version-3.0/02_concepts/code/02_single_async.py new file mode 100644 index 00000000..c6b1a0ac --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/02_single_async.py @@ -0,0 +1,16 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + + # Resource clients accept an ID of the resource + actor_client = apify_client.actor('username/actor-name') + + # Fetch the 'username/actor-name' object from the API + my_actor = await actor_client.get() + + # Start the run of 'username/actor-name' and return the Run object + my_actor_run = await actor_client.start() diff --git a/website/versioned_docs/version-3.0/02_concepts/code/02_single_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/02_single_sync.py new file mode 100644 index 00000000..033e54de --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/02_single_sync.py @@ -0,0 +1,16 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + + # Resource clients accept an ID of the resource + actor_client = apify_client.actor('username/actor-name') + + # Fetch the 'username/actor-name' object from the API + my_actor = actor_client.get() + + # Start the run of 'username/actor-name' and return the Run object + my_actor_run = actor_client.start() diff --git a/website/versioned_docs/version-3.0/02_concepts/code/03_nested_async.py b/website/versioned_docs/version-3.0/02_concepts/code/03_nested_async.py new file mode 100644 index 00000000..f1d4c27f --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/03_nested_async.py @@ -0,0 +1,22 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + + actor_client = apify_client.actor('username/actor-name') + runs_client = actor_client.runs() + + # List the last 10 runs of the Actor. + actor_runs = (await runs_client.list(limit=10, desc=True)).items + + # Select the last run of the Actor that finished with a SUCCEEDED status. + last_succeeded_run_client = actor_client.last_run(status='SUCCEEDED') + + # Get dataset + actor_run_dataset_client = last_succeeded_run_client.dataset() + + # Fetch items from the run's dataset + dataset_items = (await actor_run_dataset_client.list_items()).items diff --git a/website/versioned_docs/version-3.0/02_concepts/code/03_nested_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/03_nested_sync.py new file mode 100644 index 00000000..65ae8dd2 --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/03_nested_sync.py @@ -0,0 +1,22 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + + actor_client = apify_client.actor('username/actor-name') + runs_client = actor_client.runs() + + # List the last 10 runs of the Actor. + actor_runs = runs_client.list(limit=10, desc=True).items + + # Select the last run of the Actor that finished with a SUCCEEDED status. + last_succeeded_run_client = actor_client.last_run(status='SUCCEEDED') + + # Get dataset + actor_run_dataset_client = last_succeeded_run_client.dataset() + + # Fetch items from the run's dataset + dataset_items = actor_run_dataset_client.list_items().items diff --git a/website/versioned_docs/version-3.0/02_concepts/code/04_error_async.py b/website/versioned_docs/version-3.0/02_concepts/code/04_error_async.py new file mode 100644 index 00000000..967ed2eb --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/04_error_async.py @@ -0,0 +1,28 @@ +import asyncio + +from apify_client import ApifyClientAsync +from apify_client.errors import ApifyApiError, NotFoundError + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + + try: + # Try to list items from a non-existing dataset. + dataset_client = apify_client.dataset('non-existing-dataset-id') + dataset_items = (await dataset_client.list_items()).items + except NotFoundError: + # 404 — branch on a specific subclass when you want to react to it. + dataset_items = [] + except ApifyApiError as err: + # Catch-all for every other API error. + print(f'API error: {err}') + dataset_items = [] + + print(f'Fetched {len(dataset_items)} items.') + + +if __name__ == '__main__': + asyncio.run(main()) diff --git a/website/versioned_docs/version-3.0/02_concepts/code/04_error_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/04_error_sync.py new file mode 100644 index 00000000..7d100ba9 --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/04_error_sync.py @@ -0,0 +1,26 @@ +from apify_client import ApifyClient +from apify_client.errors import ApifyApiError, NotFoundError + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + + try: + # Try to list items from a non-existing dataset. + dataset_client = apify_client.dataset('non-existing-dataset-id') + dataset_items = dataset_client.list_items().items + except NotFoundError: + # 404 — branch on a specific subclass when you want to react to it. + dataset_items = [] + except ApifyApiError as err: + # Catch-all for every other API error. + print(f'API error: {err}') + dataset_items = [] + + print(f'Fetched {len(dataset_items)} items.') + + +if __name__ == '__main__': + main() diff --git a/website/versioned_docs/version-3.0/02_concepts/code/05_retries_async.py b/website/versioned_docs/version-3.0/02_concepts/code/05_retries_async.py new file mode 100644 index 00000000..5a349685 --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/05_retries_async.py @@ -0,0 +1,17 @@ +from datetime import timedelta + +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync( + token=TOKEN, + max_retries=4, + min_delay_between_retries=timedelta(milliseconds=500), + timeout_short=timedelta(seconds=5), + timeout_medium=timedelta(seconds=30), + timeout_long=timedelta(seconds=360), + timeout_max=timedelta(seconds=360), + ) diff --git a/website/versioned_docs/version-3.0/02_concepts/code/05_retries_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/05_retries_sync.py new file mode 100644 index 00000000..b714b536 --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/05_retries_sync.py @@ -0,0 +1,17 @@ +from datetime import timedelta + +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient( + token=TOKEN, + max_retries=4, + min_delay_between_retries=timedelta(milliseconds=500), + timeout_short=timedelta(seconds=5), + timeout_medium=timedelta(seconds=30), + timeout_long=timedelta(seconds=360), + timeout_max=timedelta(seconds=360), + ) diff --git a/website/versioned_docs/version-3.0/02_concepts/code/06_logging_config.py b/website/versioned_docs/version-3.0/02_concepts/code/06_logging_config.py new file mode 100644 index 00000000..e31a7fda --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/06_logging_config.py @@ -0,0 +1,6 @@ +import logging + +# Configure the Apify client logger +apify_client_logger = logging.getLogger('apify_client') +apify_client_logger.setLevel(logging.DEBUG) +apify_client_logger.addHandler(logging.StreamHandler()) diff --git a/website/versioned_docs/version-3.0/02_concepts/code/06_logging_formatter.py b/website/versioned_docs/version-3.0/02_concepts/code/06_logging_formatter.py new file mode 100644 index 00000000..efeeb695 --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/06_logging_formatter.py @@ -0,0 +1,15 @@ +import logging + +# Configure the Apify client logger +apify_client_logger = logging.getLogger('apify_client') +apify_client_logger.setLevel(logging.DEBUG) +apify_client_logger.addHandler(logging.StreamHandler()) + +# Create a custom logging formatter +formatter = logging.Formatter( + '%(asctime)s - %(name)s - %(levelname)s - %(message)s - ' + '%(attempt)s - %(status_code)s - %(url)s' +) +handler = logging.StreamHandler() +handler.setFormatter(formatter) +apify_client_logger.addHandler(handler) diff --git a/website/versioned_docs/version-3.0/02_concepts/code/07_call_async.py b/website/versioned_docs/version-3.0/02_concepts/code/07_call_async.py new file mode 100644 index 00000000..3fe5a56f --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/07_call_async.py @@ -0,0 +1,14 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + actor_client = apify_client.actor('username/actor-name') + + # Start an Actor and wait for it to finish. + finished_actor_run = await actor_client.call() + + # Start an Actor and wait up to 60 seconds for it to finish. + actor_run = await actor_client.start(wait_for_finish=60) diff --git a/website/versioned_docs/version-3.0/02_concepts/code/07_call_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/07_call_sync.py new file mode 100644 index 00000000..366f32ef --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/07_call_sync.py @@ -0,0 +1,14 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + actor_client = apify_client.actor('username/actor-name') + + # Start an Actor and wait for it to finish. + finished_actor_run = actor_client.call() + + # Start an Actor and wait up to 60 seconds for it to finish. + actor_run = actor_client.start(wait_for_finish=60) diff --git a/website/versioned_docs/version-2.5/02_concepts/code/08_iterate_collection_async.py b/website/versioned_docs/version-3.0/02_concepts/code/08_iterate_collection_async.py similarity index 100% rename from website/versioned_docs/version-2.5/02_concepts/code/08_iterate_collection_async.py rename to website/versioned_docs/version-3.0/02_concepts/code/08_iterate_collection_async.py diff --git a/website/versioned_docs/version-2.5/02_concepts/code/08_iterate_collection_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/08_iterate_collection_sync.py similarity index 100% rename from website/versioned_docs/version-2.5/02_concepts/code/08_iterate_collection_sync.py rename to website/versioned_docs/version-3.0/02_concepts/code/08_iterate_collection_sync.py diff --git a/website/versioned_docs/version-2.5/02_concepts/code/08_iterate_items_async.py b/website/versioned_docs/version-3.0/02_concepts/code/08_iterate_items_async.py similarity index 100% rename from website/versioned_docs/version-2.5/02_concepts/code/08_iterate_items_async.py rename to website/versioned_docs/version-3.0/02_concepts/code/08_iterate_items_async.py diff --git a/website/versioned_docs/version-2.5/02_concepts/code/08_iterate_items_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/08_iterate_items_sync.py similarity index 100% rename from website/versioned_docs/version-2.5/02_concepts/code/08_iterate_items_sync.py rename to website/versioned_docs/version-3.0/02_concepts/code/08_iterate_items_sync.py diff --git a/website/versioned_docs/version-3.0/02_concepts/code/08_pagination_async.py b/website/versioned_docs/version-3.0/02_concepts/code/08_pagination_async.py new file mode 100644 index 00000000..23ac5fde --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/08_pagination_async.py @@ -0,0 +1,24 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + + # Initialize the dataset client + dataset_client = apify_client.dataset('dataset-id') + + # Define the pagination parameters + limit = 1000 # Number items to request from API + offset = 0 # Starting offset + + # Send single API call to fetch paginated items. + # (number of items per single call can be limited by API) + paginated_items = await dataset_client.list_items(limit=limit, offset=offset) + + # Inspect pagination metadata returned by API + print(paginated_items.total) + + for item in paginated_items.items: + print(item) # Process the item as needed diff --git a/website/versioned_docs/version-3.0/02_concepts/code/08_pagination_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/08_pagination_sync.py new file mode 100644 index 00000000..f144339e --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/08_pagination_sync.py @@ -0,0 +1,24 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + + # Initialize the dataset client + dataset_client = apify_client.dataset('dataset-id') + + # Define the pagination parameters + limit = 1000 # Number items to request from API + offset = 0 # Starting offset + + # Send single API call to fetch paginated items. + # (number of items per single call can be limited by API) + paginated_items = dataset_client.list_items(limit=limit, offset=offset) + + # Inspect pagination metadata returned by API + print(paginated_items.total) + + for item in paginated_items.items: + print(item) # Process the item as needed diff --git a/website/versioned_docs/version-3.0/02_concepts/code/09_streaming_async.py b/website/versioned_docs/version-3.0/02_concepts/code/09_streaming_async.py new file mode 100644 index 00000000..5459784e --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/09_streaming_async.py @@ -0,0 +1,14 @@ +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + apify_client = ApifyClientAsync(TOKEN) + run_client = apify_client.run('MY-RUN-ID') + log_client = run_client.log() + + async with log_client.stream() as log_stream: + if log_stream: + async for bytes_chunk in log_stream.aiter_bytes(): + print(bytes_chunk) diff --git a/website/versioned_docs/version-3.0/02_concepts/code/09_streaming_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/09_streaming_sync.py new file mode 100644 index 00000000..e7617ab3 --- /dev/null +++ b/website/versioned_docs/version-3.0/02_concepts/code/09_streaming_sync.py @@ -0,0 +1,14 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + apify_client = ApifyClient(TOKEN) + run_client = apify_client.run('MY-RUN-ID') + log_client = run_client.log() + + with log_client.stream() as log_stream: + if log_stream: + for bytes_chunk in log_stream.iter_bytes(): + print(bytes_chunk) diff --git a/website/versioned_docs/version-2.5/02_concepts/code/10_architecture_imports.py b/website/versioned_docs/version-3.0/02_concepts/code/10_architecture_imports.py similarity index 100% rename from website/versioned_docs/version-2.5/02_concepts/code/10_architecture_imports.py rename to website/versioned_docs/version-3.0/02_concepts/code/10_architecture_imports.py diff --git a/website/versioned_docs/version-2.5/02_concepts/code/10_default_http_client_async.py b/website/versioned_docs/version-3.0/02_concepts/code/10_default_http_client_async.py similarity index 100% rename from website/versioned_docs/version-2.5/02_concepts/code/10_default_http_client_async.py rename to website/versioned_docs/version-3.0/02_concepts/code/10_default_http_client_async.py diff --git a/website/versioned_docs/version-2.5/02_concepts/code/10_default_http_client_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/10_default_http_client_sync.py similarity index 100% rename from website/versioned_docs/version-2.5/02_concepts/code/10_default_http_client_sync.py rename to website/versioned_docs/version-3.0/02_concepts/code/10_default_http_client_sync.py diff --git a/website/versioned_docs/version-2.5/02_concepts/code/10_plugging_in_async.py b/website/versioned_docs/version-3.0/02_concepts/code/10_plugging_in_async.py similarity index 100% rename from website/versioned_docs/version-2.5/02_concepts/code/10_plugging_in_async.py rename to website/versioned_docs/version-3.0/02_concepts/code/10_plugging_in_async.py diff --git a/website/versioned_docs/version-2.5/02_concepts/code/10_plugging_in_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/10_plugging_in_sync.py similarity index 100% rename from website/versioned_docs/version-2.5/02_concepts/code/10_plugging_in_sync.py rename to website/versioned_docs/version-3.0/02_concepts/code/10_plugging_in_sync.py diff --git a/website/versioned_docs/version-2.5/02_concepts/code/11_timeouts_async.py b/website/versioned_docs/version-3.0/02_concepts/code/11_timeouts_async.py similarity index 100% rename from website/versioned_docs/version-2.5/02_concepts/code/11_timeouts_async.py rename to website/versioned_docs/version-3.0/02_concepts/code/11_timeouts_async.py diff --git a/website/versioned_docs/version-2.5/02_concepts/code/11_timeouts_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/11_timeouts_sync.py similarity index 100% rename from website/versioned_docs/version-2.5/02_concepts/code/11_timeouts_sync.py rename to website/versioned_docs/version-3.0/02_concepts/code/11_timeouts_sync.py diff --git a/website/versioned_docs/version-2.5/02_concepts/code/12_typed_models_access_async.py b/website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_access_async.py similarity index 100% rename from website/versioned_docs/version-2.5/02_concepts/code/12_typed_models_access_async.py rename to website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_access_async.py diff --git a/website/versioned_docs/version-2.5/02_concepts/code/12_typed_models_access_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_access_sync.py similarity index 100% rename from website/versioned_docs/version-2.5/02_concepts/code/12_typed_models_access_sync.py rename to website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_access_sync.py diff --git a/website/versioned_docs/version-2.5/02_concepts/code/12_typed_models_input_async.py b/website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_input_async.py similarity index 100% rename from website/versioned_docs/version-2.5/02_concepts/code/12_typed_models_input_async.py rename to website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_input_async.py diff --git a/website/versioned_docs/version-2.5/02_concepts/code/12_typed_models_input_sync.py b/website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_input_sync.py similarity index 100% rename from website/versioned_docs/version-2.5/02_concepts/code/12_typed_models_input_sync.py rename to website/versioned_docs/version-3.0/02_concepts/code/12_typed_models_input_sync.py diff --git a/website/versioned_docs/version-3.0/03_guides/01_passing_input_to_actor.mdx b/website/versioned_docs/version-3.0/03_guides/01_passing_input_to_actor.mdx new file mode 100644 index 00000000..5ac6b91c --- /dev/null +++ b/website/versioned_docs/version-3.0/03_guides/01_passing_input_to_actor.mdx @@ -0,0 +1,29 @@ +--- +id: passing-input-to-actor +title: Pass input to an Actor +description: Run an Actor with custom input data and retrieve results. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import StreamingAsyncExample from '!!raw-loader!./code/01_input_async.py'; +import StreamingSyncExample from '!!raw-loader!./code/01_input_sync.py'; + +You can pass input data directly to the `call` method to configure and run an Actor in a single step. + +The following example shows how to pass input to the `apify/instagram-hashtag-scraper` Actor and wait for it to finish. + + + + + {StreamingAsyncExample} + + + + + {StreamingSyncExample} + + + diff --git a/website/versioned_docs/version-3.0/03_guides/02_manage_tasks_for_reusable_input.mdx b/website/versioned_docs/version-3.0/03_guides/02_manage_tasks_for_reusable_input.mdx new file mode 100644 index 00000000..205c77c5 --- /dev/null +++ b/website/versioned_docs/version-3.0/03_guides/02_manage_tasks_for_reusable_input.mdx @@ -0,0 +1,29 @@ +--- +id: manage-tasks-for-reusable-input +title: Manage tasks for reusable input +description: Create and manage tasks with reusable input configurations. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import TasksAsyncExample from '!!raw-loader!./code/02_tasks_async.py'; +import TasksSyncExample from '!!raw-loader!./code/02_tasks_sync.py'; + +When you need to run multiple inputs with the same Actor, the most convenient approach is to create multiple [tasks](https://docs.apify.com/platform/actors/running/tasks), each with different input configurations. Task inputs are stored on the Apify platform when the task is created, allowing you to reuse them easily. + +The following example shows how to create tasks for the `apify/instagram-hashtag-scraper` Actor with different inputs, manage task clients, and execute them asynchronously: + + + + + {TasksAsyncExample} + + + + + {TasksSyncExample} + + + diff --git a/website/versioned_docs/version-3.0/03_guides/03_retrieve_actor_data.mdx b/website/versioned_docs/version-3.0/03_guides/03_retrieve_actor_data.mdx new file mode 100644 index 00000000..7490f114 --- /dev/null +++ b/website/versioned_docs/version-3.0/03_guides/03_retrieve_actor_data.mdx @@ -0,0 +1,29 @@ +--- +id: retrieve-actor-data +title: Retrieve Actor data +description: Fetch, paginate, and merge datasets from Actor runs. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import RetrieveAsyncExample from '!!raw-loader!./code/03_retrieve_async.py'; +import RetrieveSyncExample from '!!raw-loader!./code/03_retrieve_sync.py'; + +Actor output data is stored in [datasets](https://docs.apify.com/platform/storage/dataset), which can be retrieved from individual Actor runs. Dataset items support pagination for efficient retrieval, and multiple datasets can be merged into a single dataset for further analysis. This merged dataset can then be exported into various formats such as CSV, JSON, XLSX, or XML. Additionally, [integrations](https://docs.apify.com/platform/integrations) provide powerful tools to automate data workflows. + +The following example shows how to fetch datasets from an Actor's runs, paginate through their items, and merge them into a single dataset for unified analysis: + + + + + {RetrieveAsyncExample} + + + + + {RetrieveSyncExample} + + + diff --git a/website/versioned_docs/version-3.0/03_guides/04_integration_with_data_libraries.mdx b/website/versioned_docs/version-3.0/03_guides/04_integration_with_data_libraries.mdx new file mode 100644 index 00000000..ab5dc4f7 --- /dev/null +++ b/website/versioned_docs/version-3.0/03_guides/04_integration_with_data_libraries.mdx @@ -0,0 +1,29 @@ +--- +id: integration-with-data-libraries +title: Integrate with data libraries +description: Load Apify dataset items into Pandas DataFrames for analysis. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; + +import PandasAsyncExample from '!!raw-loader!./code/04_pandas_async.py'; +import PandasSyncExample from '!!raw-loader!./code/04_pandas_sync.py'; + +The Apify client for Python seamlessly integrates with data analysis libraries like [Pandas](https://pandas.pydata.org/). This allows you to load dataset items directly into a Pandas [DataFrame](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html) for efficient manipulation and analysis. Pandas provides robust data structures and tools for handling large datasets, making it a powerful addition to your Apify workflows. + +The following example shows how to retrieve items from the most recent dataset of an Actor run and load them into a Pandas DataFrame for further analysis: + + + + + {PandasAsyncExample} + + + + + {PandasSyncExample} + + + diff --git a/website/versioned_docs/version-2.5/03_guides/05_custom_http_client.mdx b/website/versioned_docs/version-3.0/03_guides/05_custom_http_client.mdx similarity index 100% rename from website/versioned_docs/version-2.5/03_guides/05_custom_http_client.mdx rename to website/versioned_docs/version-3.0/03_guides/05_custom_http_client.mdx diff --git a/website/versioned_docs/version-3.0/03_guides/code/01_input_async.py b/website/versioned_docs/version-3.0/03_guides/code/01_input_async.py new file mode 100644 index 00000000..c225a0a2 --- /dev/null +++ b/website/versioned_docs/version-3.0/03_guides/code/01_input_async.py @@ -0,0 +1,26 @@ +import asyncio +from datetime import timedelta + +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + # Client initialization with the API token + apify_client = ApifyClientAsync(token=TOKEN) + + # Get the Actor client + actor_client = apify_client.actor('apify/instagram-hashtag-scraper') + + input_data = {'hashtags': ['rainbow'], 'resultsLimit': 20} + + # Run the Actor and wait for it to finish up to 60 seconds. + # Input is not persisted for next runs. + run_result = await actor_client.call( + run_input=input_data, timeout=timedelta(seconds=60) + ) + + +if __name__ == '__main__': + asyncio.run(main()) diff --git a/website/versioned_docs/version-3.0/03_guides/code/01_input_sync.py b/website/versioned_docs/version-3.0/03_guides/code/01_input_sync.py new file mode 100644 index 00000000..ea99665c --- /dev/null +++ b/website/versioned_docs/version-3.0/03_guides/code/01_input_sync.py @@ -0,0 +1,23 @@ +from datetime import timedelta + +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + # Client initialization with the API token + apify_client = ApifyClient(token=TOKEN) + + # Get the Actor client + actor_client = apify_client.actor('apify/instagram-hashtag-scraper') + + input_data = {'hashtags': ['rainbow'], 'resultsLimit': 20} + + # Run the Actor and wait for it to finish up to 60 seconds. + # Input is not persisted for next runs. + run_result = actor_client.call(run_input=input_data, timeout=timedelta(seconds=60)) + + +if __name__ == '__main__': + main() diff --git a/website/versioned_docs/version-3.0/03_guides/code/02_tasks_async.py b/website/versioned_docs/version-3.0/03_guides/code/02_tasks_async.py new file mode 100644 index 00000000..19e38304 --- /dev/null +++ b/website/versioned_docs/version-3.0/03_guides/code/02_tasks_async.py @@ -0,0 +1,45 @@ +import asyncio + +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' +HASHTAGS = ['zebra', 'lion', 'hippo'] + + +async def main() -> None: + apify_client = ApifyClientAsync(token=TOKEN) + + # Create Apify tasks + apify_tasks = [] + apify_tasks_client = apify_client.tasks() + + for hashtag in HASHTAGS: + apify_task = await apify_tasks_client.create( + name=f'hashtags-{hashtag}', + actor_id='apify/instagram-hashtag-scraper', + task_input={'hashtags': [hashtag], 'resultsLimit': 20}, + memory_mbytes=1024, + ) + apify_tasks.append(apify_task) + + print('Tasks created:', apify_tasks) + + # Create Apify task clients + apify_task_clients = [apify_client.task(task.id) for task in apify_tasks] + + print('Task clients created:', apify_task_clients) + + # Execute Apify tasks + async with asyncio.TaskGroup() as tg: + tasks = [tg.create_task(client.call()) for client in apify_task_clients] + + task_run_results = [task.result() for task in tasks] + + # Filter out None results (tasks that failed to return a run) + successful_runs = [run for run in task_run_results if run is not None] + + print('Task results:', successful_runs) + + +if __name__ == '__main__': + asyncio.run(main()) diff --git a/website/versioned_docs/version-3.0/03_guides/code/02_tasks_sync.py b/website/versioned_docs/version-3.0/03_guides/code/02_tasks_sync.py new file mode 100644 index 00000000..e869727b --- /dev/null +++ b/website/versioned_docs/version-3.0/03_guides/code/02_tasks_sync.py @@ -0,0 +1,40 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' +HASHTAGS = ['zebra', 'lion', 'hippo'] + + +def main() -> None: + apify_client = ApifyClient(token=TOKEN) + + # Create Apify tasks + apify_tasks = [] + apify_tasks_client = apify_client.tasks() + + for hashtag in HASHTAGS: + apify_task = apify_tasks_client.create( + name=f'hashtags-{hashtag}', + actor_id='apify/instagram-hashtag-scraper', + task_input={'hashtags': [hashtag], 'resultsLimit': 20}, + memory_mbytes=1024, + ) + apify_tasks.append(apify_task) + + print('Tasks created:', apify_tasks) + + # Create Apify task clients + apify_task_clients = [apify_client.task(task.id) for task in apify_tasks] + + print('Task clients created:', apify_task_clients) + + # Execute Apify tasks + task_run_results = [client.call() for client in apify_task_clients] + + # Filter out None results (tasks that failed to return a run) + successful_runs = [run for run in task_run_results if run is not None] + + print('Task results:', successful_runs) + + +if __name__ == '__main__': + main() diff --git a/website/versioned_docs/version-3.0/03_guides/code/03_retrieve_async.py b/website/versioned_docs/version-3.0/03_guides/code/03_retrieve_async.py new file mode 100644 index 00000000..fc60d068 --- /dev/null +++ b/website/versioned_docs/version-3.0/03_guides/code/03_retrieve_async.py @@ -0,0 +1,33 @@ +import asyncio + +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + # Client initialization with the API token + apify_client = ApifyClientAsync(token=TOKEN) + actor_client = apify_client.actor('apify/instagram-hashtag-scraper') + runs_client = actor_client.runs() + + # See pagination to understand how to get more datasets + actor_datasets = await runs_client.list(limit=20) + + datasets_client = apify_client.datasets() + merging_dataset = await datasets_client.get_or_create(name='merge-dataset') + + for dataset_item in actor_datasets.items: + # Dataset items can be handled here. Dataset items can be paginated + dataset_client = apify_client.dataset(dataset_item.id) + dataset_items = await dataset_client.list_items(limit=1000) + + # Items can be pushed to single dataset + merging_dataset_client = apify_client.dataset(merging_dataset.id) + await merging_dataset_client.push_items(dataset_items.items) + + # ... + + +if __name__ == '__main__': + asyncio.run(main()) diff --git a/website/versioned_docs/version-3.0/03_guides/code/03_retrieve_sync.py b/website/versioned_docs/version-3.0/03_guides/code/03_retrieve_sync.py new file mode 100644 index 00000000..24e05e2f --- /dev/null +++ b/website/versioned_docs/version-3.0/03_guides/code/03_retrieve_sync.py @@ -0,0 +1,31 @@ +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + # Client initialization with the API token + apify_client = ApifyClient(token=TOKEN) + actor_client = apify_client.actor('apify/instagram-hashtag-scraper') + runs_client = actor_client.runs() + + # See pagination to understand how to get more datasets + actor_datasets = runs_client.list(limit=20) + + datasets_client = apify_client.datasets() + merging_dataset = datasets_client.get_or_create(name='merge-dataset') + + for dataset_item in actor_datasets.items: + # Dataset items can be handled here. Dataset items can be paginated + dataset_client = apify_client.dataset(dataset_item.id) + dataset_items = dataset_client.list_items(limit=1000) + + # Items can be pushed to single dataset + merging_dataset_client = apify_client.dataset(merging_dataset.id) + merging_dataset_client.push_items(dataset_items.items) + + # ... + + +if __name__ == '__main__': + main() diff --git a/website/versioned_docs/version-3.0/03_guides/code/04_pandas_async.py b/website/versioned_docs/version-3.0/03_guides/code/04_pandas_async.py new file mode 100644 index 00000000..aecc0655 --- /dev/null +++ b/website/versioned_docs/version-3.0/03_guides/code/04_pandas_async.py @@ -0,0 +1,27 @@ +import asyncio + +import pandas as pd + +from apify_client import ApifyClientAsync + +TOKEN = 'MY-APIFY-TOKEN' + + +async def main() -> None: + # Initialize the Apify client + apify_client = ApifyClientAsync(token=TOKEN) + actor_client = apify_client.actor('apify/web-scraper') + run_client = actor_client.last_run() + dataset_client = run_client.dataset() + + # Load items from last dataset run + dataset_data = await dataset_client.list_items() + + # Pass dataset items to Pandas DataFrame + data_frame = pd.DataFrame(dataset_data.items) + + print(data_frame.info) + + +if __name__ == '__main__': + asyncio.run(main()) diff --git a/website/versioned_docs/version-3.0/03_guides/code/04_pandas_sync.py b/website/versioned_docs/version-3.0/03_guides/code/04_pandas_sync.py new file mode 100644 index 00000000..a42e074f --- /dev/null +++ b/website/versioned_docs/version-3.0/03_guides/code/04_pandas_sync.py @@ -0,0 +1,25 @@ +import pandas as pd + +from apify_client import ApifyClient + +TOKEN = 'MY-APIFY-TOKEN' + + +def main() -> None: + # Initialize the Apify client + apify_client = ApifyClient(token=TOKEN) + actor_client = apify_client.actor('apify/web-scraper') + run_client = actor_client.last_run() + dataset_client = run_client.dataset() + + # Load items from last dataset run + dataset_data = dataset_client.list_items() + + # Pass dataset items to Pandas DataFrame + data_frame = pd.DataFrame(dataset_data.items) + + print(data_frame.info) + + +if __name__ == '__main__': + main() diff --git a/website/versioned_docs/version-2.5/03_guides/code/05_custom_http_client_async.py b/website/versioned_docs/version-3.0/03_guides/code/05_custom_http_client_async.py similarity index 100% rename from website/versioned_docs/version-2.5/03_guides/code/05_custom_http_client_async.py rename to website/versioned_docs/version-3.0/03_guides/code/05_custom_http_client_async.py diff --git a/website/versioned_docs/version-2.5/03_guides/code/05_custom_http_client_sync.py b/website/versioned_docs/version-3.0/03_guides/code/05_custom_http_client_sync.py similarity index 100% rename from website/versioned_docs/version-2.5/03_guides/code/05_custom_http_client_sync.py rename to website/versioned_docs/version-3.0/03_guides/code/05_custom_http_client_sync.py diff --git a/website/versioned_docs/version-3.0/04_upgrading/upgrading_to_v2.mdx b/website/versioned_docs/version-3.0/04_upgrading/upgrading_to_v2.mdx new file mode 100644 index 00000000..ed02202b --- /dev/null +++ b/website/versioned_docs/version-3.0/04_upgrading/upgrading_to_v2.mdx @@ -0,0 +1,46 @@ +--- +id: upgrading-to-v2 +title: Upgrading to v2 +description: Breaking changes and migration guide from v1 to v2. +--- + +import ApiLink from '@theme/ApiLink'; + +This page summarizes the breaking changes between Apify Python API Client v1.x and v2.0. + +## Python version support + +Support for Python 3.9 has been dropped. The Apify Python API Client v2.x now requires Python 3.10 or later. Make sure your environment is running a compatible version before upgrading. + +## New underlying HTTP library + +In v2.0, the Apify Python API client switched from using [`httpx`](https://www.python-httpx.org/) to [`impit`](https://github.com/apify/impit) as the underlying HTTP library. However, this change shouldn't have much impact on the end user. + +## API method changes + +Several public methods have changed their signatures or behavior. + +### Removed parameters and attributes + +- The `parse_response` parameter has been removed from the `HTTPClient.call()` method. This was an internal parameter that added a private attribute to the `Response` object. +- The private `_maybe_parsed_body` attribute has been removed from the `Response` object. + +### KeyValueStoreClient + +- The deprecated parameters `as_bytes` and `as_file` have been removed from `KeyValueStoreClient.get_record()`. Use the dedicated methods `get_record_as_bytes()` and `stream_record()` instead. + +### DatasetClient + +- The `unwind` parameter no longer accepts a single string value. Use a list of strings instead: `unwind=['items']` rather than `unwind='items'`. + +## Module reorganization + +Some modules have been restructured. + +### Constants + +- Deprecated constant re-exports from `consts.py` have been removed. Constants should now be imported from the [apify-shared-python](https://github.com/apify/apify-shared-python) package if needed. + +### Errors + +- Error classes are now accessible from the public `apify_client.errors` module. See the `ApifyApiError` API reference for a complete list of available error classes. diff --git a/website/versioned_docs/version-2.5/04_upgrading/upgrading_to_v3.mdx b/website/versioned_docs/version-3.0/04_upgrading/upgrading_to_v3.mdx similarity index 100% rename from website/versioned_docs/version-2.5/04_upgrading/upgrading_to_v3.mdx rename to website/versioned_docs/version-3.0/04_upgrading/upgrading_to_v3.mdx diff --git a/website/versioned_docs/version-3.0/api-packages.json b/website/versioned_docs/version-3.0/api-packages.json new file mode 100644 index 00000000..2730ed49 --- /dev/null +++ b/website/versioned_docs/version-3.0/api-packages.json @@ -0,0 +1 @@ +[{"entryPoints":{"index":{"label":"Index","path":"src/index.ts"}},"packageRoot":".","packagePath":".","packageSlug":".","packageName":"apify-client-python-website"}] \ No newline at end of file diff --git a/website/versioned_docs/version-3.0/api-typedoc.json b/website/versioned_docs/version-3.0/api-typedoc.json new file mode 100644 index 00000000..9f797e55 --- /dev/null +++ b/website/versioned_docs/version-3.0/api-typedoc.json @@ -0,0 +1,170458 @@ +{ + "children": [ + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Total number of API method calls made by the client." + } + ] + }, + "flags": {}, + "groups": [], + "id": 2, + "module": "_statistics", + "name": "calls", + "parsedDocstring": { + "text": "Total number of API method calls made by the client." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_statistics.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 11 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Total number of HTTP requests sent, including retries." + } + ] + }, + "flags": {}, + "groups": [], + "id": 3, + "module": "_statistics", + "name": "requests", + "parsedDocstring": { + "text": "Total number of HTTP requests sent, including retries." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_statistics.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 14 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List tracking which retry attempts encountered rate limit (429) errors." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4, + "module": "_statistics", + "name": "rate_limit_errors", + "parsedDocstring": { + "text": "List tracking which retry attempts encountered rate limit (429) errors." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_statistics.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 17 + } + ], + "type": { + "name": "defaultdict", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add rate limit error for specific attempt.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 5, + "module": "_statistics", + "name": "add_rate_limit_error", + "parsedDocstring": { + "text": "Add rate limit error for specific attempt.\n", + "args": { + "attempt": "The attempt number (1-based indexing)." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_statistics.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 20 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add rate limit error for specific attempt.\n" + } + ] + }, + "flags": {}, + "id": 6, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "add_rate_limit_error", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The attempt number (1-based indexing)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 7, + "kind": 32768, + "kindString": "Parameter", + "name": "attempt", + "type": { + "name": "int", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statistics about API client usage and rate limit errors." + } + ] + }, + "decorations": [ + { + "name": "dataclass" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 5 + ], + "title": "Methods" + }, + { + "children": [ + 2, + 4, + 3 + ], + "title": "Properties" + } + ], + "id": 1, + "module": "_statistics", + "name": "ClientStatistics", + "parsedDocstring": { + "text": "Statistics about API client usage and rate limit errors." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_statistics.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 8 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 8, + "module": "_docs", + "name": "GroupName", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_docs.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 8 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 9, + "module": "_docs", + "name": "T", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_docs.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 18 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Mark a symbol for rendering and grouping in documentation.\n\nThis decorator is used solely for documentation purposes and does not modify the behavior\nof the decorated callable.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 10, + "module": "_docs", + "name": "docs_group", + "parsedDocstring": { + "text": "Mark a symbol for rendering and grouping in documentation.\n\nThis decorator is used solely for documentation purposes and does not modify the behavior\nof the decorated callable.\n", + "args": { + "group_name": "The documentation group to which the symbol belongs.\n" + }, + "returns": "The original callable without modification." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_docs.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 21 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The original callable without modification." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Mark a symbol for rendering and grouping in documentation.\n\nThis decorator is used solely for documentation purposes and does not modify the behavior\nof the decorated callable.\n" + } + ] + }, + "flags": {}, + "id": 11, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "docs_group", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The documentation group to which the symbol belongs.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 12, + "kind": 32768, + "kindString": "Parameter", + "name": "group_name", + "type": { + "name": "GroupName", + "type": "reference", + "target": "8" + } + } + ], + "type": { + "name": "Callable", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "[T]" + }, + { + "type": "reference", + "name": "T", + "target": "9" + } + ] + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Type for the `timeout` parameter on resource client methods.\n\n`'short'`, `'medium'`, and `'long'` are tier literals resolved by the HTTP client to configured values.\nA `timedelta` overrides the timeout for this call, and `'no_timeout'` disables the timeout entirely." + } + ] + }, + "flags": {}, + "groups": [], + "id": 13, + "module": "types", + "name": "Timeout", + "parsedDocstring": { + "text": "Type for the `timeout` parameter on resource client methods.\n\n`'short'`, `'medium'`, and `'long'` are tier literals resolved by the HTTP client to configured values.\nA `timedelta` overrides the timeout for this call, and `'no_timeout'` disables the timeout entirely." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/types.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 14 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Type for the `webhooks` parameter on resource-client `start`/`call` methods and `from_webhooks`.\n\n`WebhookRepresentation` / `WebhookRepresentationDict` / `WebhookRepresentationCamelDict` are the minimal ad-hoc\nwebhook shape (only `event_types` and `request_url` required). `WebhookCreate` / `WebhookCreateDict` /\n`WebhookCreateCamelDict` are accepted so a persistent-webhook definition can be reused; their fields not relevant\nto ad-hoc webhooks (e.g. `condition`) are ignored at runtime. The `*CamelDict` variants accept camelCase keys\nmatching the Apify API spelling." + } + ] + }, + "flags": {}, + "groups": [], + "id": 14, + "module": "types", + "name": "WebhooksList", + "parsedDocstring": { + "text": "Type for the `webhooks` parameter on resource-client `start`/`call` methods and `from_webhooks`.\n\n`WebhookRepresentation` / `WebhookRepresentationDict` / `WebhookRepresentationCamelDict` are the minimal ad-hoc\nwebhook shape (only `event_types` and `request_url` required). `WebhookCreate` / `WebhookCreateDict` /\n`WebhookCreateCamelDict` are accepted so a persistent-webhook definition can be reused; their fields not relevant\nto ad-hoc webhooks (e.g. `condition`) are ignored at runtime. The `*CamelDict` variants accept camelCase keys\nmatching the Apify API spelling." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/types.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 21 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Recursive type for JSON-serializable values - primitives plus objects and arrays with JSON-serializable contents.\n\nBased on the definition discussed in https://github.com/python/typing/issues/182." + } + ] + }, + "flags": {}, + "groups": [], + "id": 15, + "module": "types", + "name": "JsonSerializable", + "parsedDocstring": { + "text": "Recursive type for JSON-serializable values - primitives plus objects and arrays with JSON-serializable contents.\n\nBased on the definition discussed in https://github.com/python/typing/issues/182." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/types.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 38 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for all Apify API client errors." + } + ] + }, + "decorations": [ + { + "args": "('Errors')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [], + "id": 16, + "module": "errors", + "name": "ApifyClientError", + "parsedDocstring": { + "text": "Base class for all Apify API client errors." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 15 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "ApifyApiError", + "target": "17", + "type": "reference" + }, + { + "name": "InvalidResponseBodyError", + "target": "35", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 18, + "module": "errors", + "name": "__new__", + "parsedDocstring": { + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 42 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + } + ] + }, + "flags": {}, + "id": 19, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__new__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 20, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 21, + "kind": 32768, + "kindString": "Parameter", + "name": "attempt", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "defaultValue": "'GET'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 22, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "Self", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the API error from a failed response.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 23, + "module": "errors", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the API error from a failed response.\n", + "args": { + "response": "The failed HTTP response from the Apify API.", + "attempt": "The attempt number when the request failed (1-indexed).", + "method": "The HTTP method of the failed request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 54 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the API error from a failed response.\n" + } + ] + }, + "flags": {}, + "id": 24, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The failed HTTP response from the Apify API." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 25, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The attempt number when the request failed (1-indexed)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 26, + "kind": 32768, + "kindString": "Parameter", + "name": "attempt", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The HTTP method of the failed request." + } + ] + }, + "defaultValue": "'GET'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 27, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error raised when the Apify API returns an error response.\n\nInstantiating `ApifyApiError` dispatches to the subclass matching the HTTP status code (e.g. 404 → `NotFoundError`,\nany 5xx → `ServerError`). Unmapped statuses stay on `ApifyApiError`. Existing `except ApifyApiError` handlers keep\nworking because every subclass inherits from this class.\n\nThe `type`, `message` and `data` fields from the response body are exposed for inspection but are treated as\nnon-authoritative metadata — dispatch is driven by the status code only.\n" + } + ] + }, + "decorations": [ + { + "args": "('Errors')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 23, + 18 + ], + "title": "Methods" + } + ], + "id": 17, + "module": "errors", + "name": "ApifyApiError", + "parsedDocstring": { + "text": "Error raised when the Apify API returns an error response.\n\nInstantiating `ApifyApiError` dispatches to the subclass matching the HTTP status code (e.g. 404 → `NotFoundError`,\nany 5xx → `ServerError`). Unmapped statuses stay on `ApifyApiError`. Existing `except ApifyApiError` handlers keep\nworking because every subclass inherits from this class.\n\nThe `type`, `message` and `data` fields from the response body are exposed for inspection but are treated as\nnon-authoritative metadata — dispatch is driven by the status code only.\n" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 20 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ApifyClientError", + "target": "16", + "type": "reference" + } + ], + "extendedBy": [ + { + "name": "InvalidRequestError", + "target": "28", + "type": "reference" + }, + { + "name": "UnauthorizedError", + "target": "29", + "type": "reference" + }, + { + "name": "ForbiddenError", + "target": "30", + "type": "reference" + }, + { + "name": "NotFoundError", + "target": "31", + "type": "reference" + }, + { + "name": "ConflictError", + "target": "32", + "type": "reference" + }, + { + "name": "RateLimitError", + "target": "33", + "type": "reference" + }, + { + "name": "ServerError", + "target": "34", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 4167, + "module": "errors", + "name": "__new__", + "parsedDocstring": { + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 42 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + } + ] + }, + "flags": {}, + "id": 19, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__new__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 20, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 21, + "kind": 32768, + "kindString": "Parameter", + "name": "attempt", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "defaultValue": "'GET'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 22, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "Self", + "type": "reference" + }, + "inheritedFrom": { + "name": "ApifyApiError.__new__", + "target": 18, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "ApifyApiError.__new__", + "target": 18, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the API error from a failed response.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 4168, + "module": "errors", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the API error from a failed response.\n", + "args": { + "response": "The failed HTTP response from the Apify API.", + "attempt": "The attempt number when the request failed (1-indexed).", + "method": "The HTTP method of the failed request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 54 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the API error from a failed response.\n" + } + ] + }, + "flags": {}, + "id": 24, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The failed HTTP response from the Apify API." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 25, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The attempt number when the request failed (1-indexed)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 26, + "kind": 32768, + "kindString": "Parameter", + "name": "attempt", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The HTTP method of the failed request." + } + ] + }, + "defaultValue": "'GET'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 27, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ApifyApiError.__init__", + "target": 23, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "ApifyApiError.__init__", + "target": 23, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Raised when the Apify API returns an HTTP 400 Bad Request response." + } + ] + }, + "decorations": [ + { + "args": "('Errors')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4168, + 4167 + ], + "title": "Methods" + } + ], + "id": 28, + "module": "errors", + "name": "InvalidRequestError", + "parsedDocstring": { + "text": "Raised when the Apify API returns an HTTP 400 Bad Request response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 94 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ApifyApiError", + "target": "17", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 4169, + "module": "errors", + "name": "__new__", + "parsedDocstring": { + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 42 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + } + ] + }, + "flags": {}, + "id": 19, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__new__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 20, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 21, + "kind": 32768, + "kindString": "Parameter", + "name": "attempt", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "defaultValue": "'GET'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 22, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "Self", + "type": "reference" + }, + "inheritedFrom": { + "name": "ApifyApiError.__new__", + "target": 18, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "ApifyApiError.__new__", + "target": 18, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the API error from a failed response.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 4170, + "module": "errors", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the API error from a failed response.\n", + "args": { + "response": "The failed HTTP response from the Apify API.", + "attempt": "The attempt number when the request failed (1-indexed).", + "method": "The HTTP method of the failed request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 54 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the API error from a failed response.\n" + } + ] + }, + "flags": {}, + "id": 24, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The failed HTTP response from the Apify API." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 25, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The attempt number when the request failed (1-indexed)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 26, + "kind": 32768, + "kindString": "Parameter", + "name": "attempt", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The HTTP method of the failed request." + } + ] + }, + "defaultValue": "'GET'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 27, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ApifyApiError.__init__", + "target": 23, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "ApifyApiError.__init__", + "target": 23, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Raised when the Apify API returns an HTTP 401 Unauthorized response." + } + ] + }, + "decorations": [ + { + "args": "('Errors')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4170, + 4169 + ], + "title": "Methods" + } + ], + "id": 29, + "module": "errors", + "name": "UnauthorizedError", + "parsedDocstring": { + "text": "Raised when the Apify API returns an HTTP 401 Unauthorized response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 99 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ApifyApiError", + "target": "17", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 4171, + "module": "errors", + "name": "__new__", + "parsedDocstring": { + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 42 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + } + ] + }, + "flags": {}, + "id": 19, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__new__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 20, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 21, + "kind": 32768, + "kindString": "Parameter", + "name": "attempt", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "defaultValue": "'GET'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 22, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "Self", + "type": "reference" + }, + "inheritedFrom": { + "name": "ApifyApiError.__new__", + "target": 18, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "ApifyApiError.__new__", + "target": 18, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the API error from a failed response.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 4172, + "module": "errors", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the API error from a failed response.\n", + "args": { + "response": "The failed HTTP response from the Apify API.", + "attempt": "The attempt number when the request failed (1-indexed).", + "method": "The HTTP method of the failed request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 54 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the API error from a failed response.\n" + } + ] + }, + "flags": {}, + "id": 24, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The failed HTTP response from the Apify API." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 25, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The attempt number when the request failed (1-indexed)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 26, + "kind": 32768, + "kindString": "Parameter", + "name": "attempt", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The HTTP method of the failed request." + } + ] + }, + "defaultValue": "'GET'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 27, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ApifyApiError.__init__", + "target": 23, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "ApifyApiError.__init__", + "target": 23, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Raised when the Apify API returns an HTTP 403 Forbidden response." + } + ] + }, + "decorations": [ + { + "args": "('Errors')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4172, + 4171 + ], + "title": "Methods" + } + ], + "id": 30, + "module": "errors", + "name": "ForbiddenError", + "parsedDocstring": { + "text": "Raised when the Apify API returns an HTTP 403 Forbidden response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 104 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ApifyApiError", + "target": "17", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 4173, + "module": "errors", + "name": "__new__", + "parsedDocstring": { + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 42 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + } + ] + }, + "flags": {}, + "id": 19, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__new__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 20, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 21, + "kind": 32768, + "kindString": "Parameter", + "name": "attempt", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "defaultValue": "'GET'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 22, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "Self", + "type": "reference" + }, + "inheritedFrom": { + "name": "ApifyApiError.__new__", + "target": 18, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "ApifyApiError.__new__", + "target": 18, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the API error from a failed response.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 4174, + "module": "errors", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the API error from a failed response.\n", + "args": { + "response": "The failed HTTP response from the Apify API.", + "attempt": "The attempt number when the request failed (1-indexed).", + "method": "The HTTP method of the failed request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 54 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the API error from a failed response.\n" + } + ] + }, + "flags": {}, + "id": 24, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The failed HTTP response from the Apify API." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 25, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The attempt number when the request failed (1-indexed)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 26, + "kind": 32768, + "kindString": "Parameter", + "name": "attempt", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The HTTP method of the failed request." + } + ] + }, + "defaultValue": "'GET'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 27, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ApifyApiError.__init__", + "target": 23, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "ApifyApiError.__init__", + "target": 23, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Raised when the Apify API returns an HTTP 404 Not Found response." + } + ] + }, + "decorations": [ + { + "args": "('Errors')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4174, + 4173 + ], + "title": "Methods" + } + ], + "id": 31, + "module": "errors", + "name": "NotFoundError", + "parsedDocstring": { + "text": "Raised when the Apify API returns an HTTP 404 Not Found response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 109 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ApifyApiError", + "target": "17", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 4175, + "module": "errors", + "name": "__new__", + "parsedDocstring": { + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 42 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + } + ] + }, + "flags": {}, + "id": 19, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__new__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 20, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 21, + "kind": 32768, + "kindString": "Parameter", + "name": "attempt", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "defaultValue": "'GET'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 22, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "Self", + "type": "reference" + }, + "inheritedFrom": { + "name": "ApifyApiError.__new__", + "target": 18, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "ApifyApiError.__new__", + "target": 18, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the API error from a failed response.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 4176, + "module": "errors", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the API error from a failed response.\n", + "args": { + "response": "The failed HTTP response from the Apify API.", + "attempt": "The attempt number when the request failed (1-indexed).", + "method": "The HTTP method of the failed request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 54 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the API error from a failed response.\n" + } + ] + }, + "flags": {}, + "id": 24, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The failed HTTP response from the Apify API." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 25, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The attempt number when the request failed (1-indexed)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 26, + "kind": 32768, + "kindString": "Parameter", + "name": "attempt", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The HTTP method of the failed request." + } + ] + }, + "defaultValue": "'GET'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 27, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ApifyApiError.__init__", + "target": 23, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "ApifyApiError.__init__", + "target": 23, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Raised when the Apify API returns an HTTP 409 Conflict response." + } + ] + }, + "decorations": [ + { + "args": "('Errors')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4176, + 4175 + ], + "title": "Methods" + } + ], + "id": 32, + "module": "errors", + "name": "ConflictError", + "parsedDocstring": { + "text": "Raised when the Apify API returns an HTTP 409 Conflict response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 114 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ApifyApiError", + "target": "17", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 4177, + "module": "errors", + "name": "__new__", + "parsedDocstring": { + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 42 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + } + ] + }, + "flags": {}, + "id": 19, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__new__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 20, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 21, + "kind": 32768, + "kindString": "Parameter", + "name": "attempt", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "defaultValue": "'GET'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 22, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "Self", + "type": "reference" + }, + "inheritedFrom": { + "name": "ApifyApiError.__new__", + "target": 18, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "ApifyApiError.__new__", + "target": 18, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the API error from a failed response.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 4178, + "module": "errors", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the API error from a failed response.\n", + "args": { + "response": "The failed HTTP response from the Apify API.", + "attempt": "The attempt number when the request failed (1-indexed).", + "method": "The HTTP method of the failed request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 54 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the API error from a failed response.\n" + } + ] + }, + "flags": {}, + "id": 24, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The failed HTTP response from the Apify API." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 25, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The attempt number when the request failed (1-indexed)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 26, + "kind": 32768, + "kindString": "Parameter", + "name": "attempt", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The HTTP method of the failed request." + } + ] + }, + "defaultValue": "'GET'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 27, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ApifyApiError.__init__", + "target": 23, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "ApifyApiError.__init__", + "target": 23, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Raised when the Apify API returns an HTTP 429 Too Many Requests response.\n\nRate-limited requests are retried automatically; this error is only raised after all retry attempts have been\nexhausted." + } + ] + }, + "decorations": [ + { + "args": "('Errors')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4178, + 4177 + ], + "title": "Methods" + } + ], + "id": 33, + "module": "errors", + "name": "RateLimitError", + "parsedDocstring": { + "text": "Raised when the Apify API returns an HTTP 429 Too Many Requests response.\n\nRate-limited requests are retried automatically; this error is only raised after all retry attempts have been\nexhausted." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 119 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ApifyApiError", + "target": "17", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 4179, + "module": "errors", + "name": "__new__", + "parsedDocstring": { + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 42 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Dispatch to the subclass matching the response's HTTP status code, if any." + } + ] + }, + "flags": {}, + "id": 19, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__new__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 20, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 21, + "kind": 32768, + "kindString": "Parameter", + "name": "attempt", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "defaultValue": "'GET'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 22, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "Self", + "type": "reference" + }, + "inheritedFrom": { + "name": "ApifyApiError.__new__", + "target": 18, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "ApifyApiError.__new__", + "target": 18, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the API error from a failed response.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 4180, + "module": "errors", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the API error from a failed response.\n", + "args": { + "response": "The failed HTTP response from the Apify API.", + "attempt": "The attempt number when the request failed (1-indexed).", + "method": "The HTTP method of the failed request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 54 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the API error from a failed response.\n" + } + ] + }, + "flags": {}, + "id": 24, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The failed HTTP response from the Apify API." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 25, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The attempt number when the request failed (1-indexed)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 26, + "kind": 32768, + "kindString": "Parameter", + "name": "attempt", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The HTTP method of the failed request." + } + ] + }, + "defaultValue": "'GET'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 27, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ApifyApiError.__init__", + "target": 23, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "ApifyApiError.__init__", + "target": 23, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Raised when the Apify API returns an HTTP 5xx response.\n\nServer errors are retried automatically; this error is only raised after all retry attempts have been exhausted." + } + ] + }, + "decorations": [ + { + "args": "('Errors')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4180, + 4179 + ], + "title": "Methods" + } + ], + "id": 34, + "module": "errors", + "name": "ServerError", + "parsedDocstring": { + "text": "Raised when the Apify API returns an HTTP 5xx response.\n\nServer errors are retried automatically; this error is only raised after all retry attempts have been exhausted." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 128 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ApifyApiError", + "target": "17", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the error from an unparsable response.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 36, + "module": "errors", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the error from an unparsable response.\n", + "args": { + "response": "The HTTP response whose body could not be parsed." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 144 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the error from an unparsable response.\n" + } + ] + }, + "flags": {}, + "id": 37, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The HTTP response whose body could not be parsed." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 38, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error raised when a response body cannot be parsed.\n\nThis typically occurs when the API returns a partial or malformed JSON response, for example due to a network\ninterruption. The client retries such requests automatically, so this error is only raised after all retry\nattempts have been exhausted." + } + ] + }, + "decorations": [ + { + "args": "('Errors')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 36 + ], + "title": "Methods" + } + ], + "id": 35, + "module": "errors", + "name": "InvalidResponseBodyError", + "parsedDocstring": { + "text": "Error raised when a response body cannot be parsed.\n\nThis typically occurs when the API returns a partial or malformed JSON response, for example due to a network\ninterruption. The client retries such requests automatically, so this error is only raised after all retry\nattempts have been exhausted." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/errors.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 136 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ApifyClientError", + "target": "16", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 40, + "module": "_streamed_log", + "name": "__init__", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_streamed_log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 26 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 41, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 42, + "kind": 32768, + "kindString": "Parameter", + "name": "to_logger", + "type": { + "name": "logging.Logger", + "type": "reference" + } + }, + { + "defaultValue": "True", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 43, + "kind": 32768, + "kindString": "Parameter", + "name": "from_start", + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for streaming and buffering chunked Actor run logs." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 40 + ], + "title": "Methods" + } + ], + "id": 39, + "module": "_streamed_log", + "name": "StreamedLogBase", + "parsedDocstring": { + "text": "Base class for streaming and buffering chunked Actor run logs." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_streamed_log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 20 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "StreamedLog", + "target": "44", + "type": "reference" + }, + { + "name": "StreamedLogAsync", + "target": "61", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StreamedLog`.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 45, + "module": "_streamed_log", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize `StreamedLog`.\n", + "args": { + "log_client": "The log client used to stream raw log data from the Actor run.", + "to_logger": "The logger to which the log messages will be forwarded.", + "from_start": "If `True`, all logs from the start of the Actor run will be streamed. If `False`, only newly\narrived logs will be streamed. This can be useful for long-running Actors in stand-by mode where only\nrecent logs are relevant." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_streamed_log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 93 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StreamedLog`.\n" + } + ] + }, + "flags": {}, + "id": 46, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The log client used to stream raw log data from the Actor run." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 47, + "kind": 32768, + "kindString": "Parameter", + "name": "log_client", + "type": { + "name": "LogClient", + "type": "reference", + "target": "2160" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The logger to which the log messages will be forwarded." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 48, + "kind": 32768, + "kindString": "Parameter", + "name": "to_logger", + "type": { + "name": "logging.Logger", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If `True`, all logs from the start of the Actor run will be streamed. If `False`, only newly\narrived logs will be streamed. This can be useful for long-running Actors in stand-by mode where only\nrecent logs are relevant." + } + ] + }, + "defaultValue": "True", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 49, + "kind": 32768, + "kindString": "Parameter", + "name": "from_start", + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "StreamedLogBase.__init__", + "target": 40, + "type": "reference" + } + } + ], + "overwrites": { + "name": "StreamedLogBase.__init__", + "target": 40, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming thread.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 50, + "module": "_streamed_log", + "name": "start", + "parsedDocstring": { + "text": "Start the streaming thread.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_streamed_log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 108 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming thread.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." + } + ] + }, + "flags": {}, + "id": 51, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "start", + "parameters": [], + "type": { + "name": "Thread", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signal the streaming thread to stop logging and wait for it to finish." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 52, + "module": "_streamed_log", + "name": "stop", + "parsedDocstring": { + "text": "Signal the streaming thread to stop logging and wait for it to finish." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_streamed_log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 120 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signal the streaming thread to stop logging and wait for it to finish." + } + ] + }, + "flags": {}, + "id": 53, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "stop", + "parameters": [], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming thread within the context. Exiting the context will finish the streaming thread." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 54, + "module": "_streamed_log", + "name": "__enter__", + "parsedDocstring": { + "text": "Start the streaming thread within the context. Exiting the context will finish the streaming thread." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_streamed_log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 129 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming thread within the context. Exiting the context will finish the streaming thread." + } + ] + }, + "flags": {}, + "id": 55, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__enter__", + "parameters": [], + "type": { + "name": "Self", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stop the streaming thread." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 56, + "module": "_streamed_log", + "name": "__exit__", + "parsedDocstring": { + "text": "Stop the streaming thread." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_streamed_log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 134 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stop the streaming thread." + } + ] + }, + "flags": {}, + "id": 57, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__exit__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 58, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_type", + "type": { + "name": "type[BaseException] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "type", + "typeArguments": [ + { + "type": "reference", + "name": "BaseException" + } + ], + "target": "474" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 59, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_val", + "type": { + "name": "BaseException | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "BaseException" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 60, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_tb", + "type": { + "name": "TracebackType | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "TracebackType" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Streams Actor run log output to a Python logger in a background thread.\n\nThe log stream is consumed in a background thread and each log message is forwarded to the provided logger with\nan appropriate log level inferred from the message content.\n\nCan be used as a context manager, which automatically starts and stops the streaming thread. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClient.get_streamed_log`." + } + ] + }, + "decorations": [ + { + "args": "('Other')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 54, + 56, + 45, + 50, + 52 + ], + "title": "Methods" + } + ], + "id": 44, + "module": "_streamed_log", + "name": "StreamedLog", + "parsedDocstring": { + "text": "Streams Actor run log output to a Python logger in a background thread.\n\nThe log stream is consumed in a background thread and each log message is forwarded to the provided logger with\nan appropriate log level inferred from the message content.\n\nCan be used as a context manager, which automatically starts and stops the streaming thread. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClient.get_streamed_log`." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_streamed_log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 83 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "StreamedLogBase", + "target": "39", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StreamedLogAsync`.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 62, + "module": "_streamed_log", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize `StreamedLogAsync`.\n", + "args": { + "log_client": "The async log client used to stream raw log data from the Actor run.", + "to_logger": "The logger to which the log messages will be forwarded.", + "from_start": "If `True`, all logs from the start of the Actor run will be streamed. If `False`, only newly\narrived logs will be streamed. This can be useful for long-running Actors in stand-by mode where only\nrecent logs are relevant." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_streamed_log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 165 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StreamedLogAsync`.\n" + } + ] + }, + "flags": {}, + "id": 63, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The async log client used to stream raw log data from the Actor run." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 64, + "kind": 32768, + "kindString": "Parameter", + "name": "log_client", + "type": { + "name": "LogClientAsync", + "type": "reference", + "target": "2177" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The logger to which the log messages will be forwarded." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 65, + "kind": 32768, + "kindString": "Parameter", + "name": "to_logger", + "type": { + "name": "logging.Logger", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If `True`, all logs from the start of the Actor run will be streamed. If `False`, only newly\narrived logs will be streamed. This can be useful for long-running Actors in stand-by mode where only\nrecent logs are relevant." + } + ] + }, + "defaultValue": "True", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 66, + "kind": 32768, + "kindString": "Parameter", + "name": "from_start", + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "StreamedLogBase.__init__", + "target": 40, + "type": "reference" + } + } + ], + "overwrites": { + "name": "StreamedLogBase.__init__", + "target": 40, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming task.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 67, + "module": "_streamed_log", + "name": "start", + "parsedDocstring": { + "text": "Start the streaming task.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_streamed_log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 179 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming task.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." + } + ] + }, + "flags": {}, + "id": 68, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "start", + "parameters": [], + "type": { + "name": "Task", + "type": "reference", + "target": "1197" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stop the streaming task." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 69, + "module": "_streamed_log", + "name": "stop", + "parsedDocstring": { + "text": "Stop the streaming task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_streamed_log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 189 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stop the streaming task." + } + ] + }, + "flags": {}, + "id": 70, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "stop", + "parameters": [], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming task within the context. Exiting the context will cancel the streaming task." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 71, + "module": "_streamed_log", + "name": "__aenter__", + "parsedDocstring": { + "text": "Start the streaming task within the context. Exiting the context will cancel the streaming task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_streamed_log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 202 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the streaming task within the context. Exiting the context will cancel the streaming task." + } + ] + }, + "flags": {}, + "id": 72, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "__aenter__", + "parameters": [], + "type": { + "name": "Self", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Cancel the streaming task." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 73, + "module": "_streamed_log", + "name": "__aexit__", + "parsedDocstring": { + "text": "Cancel the streaming task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_streamed_log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 207 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Cancel the streaming task." + } + ] + }, + "flags": {}, + "id": 74, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "__aexit__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 75, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_type", + "type": { + "name": "type[BaseException] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "type", + "typeArguments": [ + { + "type": "reference", + "name": "BaseException" + } + ], + "target": "474" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 76, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_val", + "type": { + "name": "BaseException | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "BaseException" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 77, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_tb", + "type": { + "name": "TracebackType | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "TracebackType" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Streams Actor run log output to a Python logger in an asyncio task.\n\nThe log stream is consumed in a background asyncio task and each log message is forwarded to the provided logger\nwith an appropriate log level inferred from the message content.\n\nCan be used as an async context manager, which automatically starts and cancels the streaming task. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClientAsync.get_streamed_log`." + } + ] + }, + "decorations": [ + { + "args": "('Other')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 71, + 73, + 62, + 67, + 69 + ], + "title": "Methods" + } + ], + "id": 61, + "module": "_streamed_log", + "name": "StreamedLogAsync", + "parsedDocstring": { + "text": "Streams Actor run log output to a Python logger in an asyncio task.\n\nThe log stream is consumed in a background asyncio task and each log message is forwarded to the provided logger\nwith an appropriate log level inferred from the message content.\n\nCan be used as an async context manager, which automatically starts and cancels the streaming task. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClientAsync.get_streamed_log`." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_streamed_log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 155 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "StreamedLogBase", + "target": "39", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 79, + "module": "_typeddicts", + "name": "unique_key", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 12 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 80, + "module": "_typeddicts", + "name": "url", + "parsedDocstring": { + "text": "The URL of the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 16 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 81, + "module": "_typeddicts", + "name": "method", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 20 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "GET" + }, + { + "type": "literal", + "value": "HEAD" + }, + { + "type": "literal", + "value": "POST" + }, + { + "type": "literal", + "value": "PUT" + }, + { + "type": "literal", + "value": "DELETE" + }, + { + "type": "literal", + "value": "CONNECT" + }, + { + "type": "literal", + "value": "OPTIONS" + }, + { + "type": "literal", + "value": "TRACE" + }, + { + "type": "literal", + "value": "PATCH" + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of times this request has been retried." + } + ] + }, + "flags": {}, + "groups": [], + "id": 82, + "module": "_typeddicts", + "name": "retry_count", + "parsedDocstring": { + "text": "The number of times this request has been retried." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 21 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The final URL that was loaded, after redirects (if any)." + } + ] + }, + "flags": {}, + "groups": [], + "id": 83, + "module": "_typeddicts", + "name": "loaded_url", + "parsedDocstring": { + "text": "The final URL that was loaded, after redirects (if any)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 25 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The request payload, typically used with POST or PUT requests." + } + ] + }, + "flags": {}, + "groups": [], + "id": 84, + "module": "_typeddicts", + "name": "payload", + "parsedDocstring": { + "text": "The request payload, typically used with POST or PUT requests." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 29 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP headers sent with the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 85, + "module": "_typeddicts", + "name": "headers", + "parsedDocstring": { + "text": "HTTP headers sent with the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 33 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 86, + "module": "_typeddicts", + "name": "user_data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 37 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "dict[str, Any]" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Indicates whether the request should not be retried if processing fails." + } + ] + }, + "flags": {}, + "groups": [], + "id": 87, + "module": "_typeddicts", + "name": "no_retry", + "parsedDocstring": { + "text": "Indicates whether the request should not be retried if processing fails." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 38 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error messages recorded from failed processing attempts." + } + ] + }, + "flags": {}, + "groups": [], + "id": 88, + "module": "_typeddicts", + "name": "error_messages", + "parsedDocstring": { + "text": "Error messages recorded from failed processing attempts." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 42 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timestamp when the request was marked as handled, if applicable." + } + ] + }, + "flags": {}, + "groups": [], + "id": 89, + "module": "_typeddicts", + "name": "handled_at", + "parsedDocstring": { + "text": "The timestamp when the request was marked as handled, if applicable." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 46 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Typed dicts')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 88, + 89, + 85, + 83, + 81, + 87, + 84, + 82, + 79, + 80, + 86 + ], + "title": "Properties" + } + ], + "id": 78, + "module": "_typeddicts", + "name": "RequestBaseDict", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 11 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "RequestDict", + "target": "102", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 91, + "module": "_typeddicts", + "name": "uniqueKey", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 54 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 92, + "module": "_typeddicts", + "name": "url", + "parsedDocstring": { + "text": "The URL of the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 58 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 93, + "module": "_typeddicts", + "name": "method", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 62 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "GET" + }, + { + "type": "literal", + "value": "HEAD" + }, + { + "type": "literal", + "value": "POST" + }, + { + "type": "literal", + "value": "PUT" + }, + { + "type": "literal", + "value": "DELETE" + }, + { + "type": "literal", + "value": "CONNECT" + }, + { + "type": "literal", + "value": "OPTIONS" + }, + { + "type": "literal", + "value": "TRACE" + }, + { + "type": "literal", + "value": "PATCH" + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of times this request has been retried." + } + ] + }, + "flags": {}, + "groups": [], + "id": 94, + "module": "_typeddicts", + "name": "retryCount", + "parsedDocstring": { + "text": "The number of times this request has been retried." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 63 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The final URL that was loaded, after redirects (if any)." + } + ] + }, + "flags": {}, + "groups": [], + "id": 95, + "module": "_typeddicts", + "name": "loadedUrl", + "parsedDocstring": { + "text": "The final URL that was loaded, after redirects (if any)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 67 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The request payload, typically used with POST or PUT requests." + } + ] + }, + "flags": {}, + "groups": [], + "id": 96, + "module": "_typeddicts", + "name": "payload", + "parsedDocstring": { + "text": "The request payload, typically used with POST or PUT requests." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 71 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP headers sent with the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 97, + "module": "_typeddicts", + "name": "headers", + "parsedDocstring": { + "text": "HTTP headers sent with the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 75 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 98, + "module": "_typeddicts", + "name": "userData", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 79 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "dict[str, Any]" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Indicates whether the request should not be retried if processing fails." + } + ] + }, + "flags": {}, + "groups": [], + "id": 99, + "module": "_typeddicts", + "name": "noRetry", + "parsedDocstring": { + "text": "Indicates whether the request should not be retried if processing fails." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 80 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error messages recorded from failed processing attempts." + } + ] + }, + "flags": {}, + "groups": [], + "id": 100, + "module": "_typeddicts", + "name": "errorMessages", + "parsedDocstring": { + "text": "Error messages recorded from failed processing attempts." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 84 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timestamp when the request was marked as handled, if applicable." + } + ] + }, + "flags": {}, + "groups": [], + "id": 101, + "module": "_typeddicts", + "name": "handledAt", + "parsedDocstring": { + "text": "The timestamp when the request was marked as handled, if applicable." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 88 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Typed dicts')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 100, + 101, + 97, + 95, + 93, + 99, + 96, + 94, + 91, + 92, + 98 + ], + "title": "Properties" + } + ], + "id": 90, + "module": "_typeddicts", + "name": "RequestBaseCamelDict", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 53 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "RequestCamelDict", + "target": "104", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 103, + "module": "_typeddicts", + "name": "id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 98 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4156, + "module": "_typeddicts", + "name": "unique_key", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 12 + } + ], + "type": { + "name": "NotRequired[str]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBaseDict.unique_key", + "target": 79, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4157, + "module": "_typeddicts", + "name": "url", + "parsedDocstring": { + "text": "The URL of the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 16 + } + ], + "type": { + "name": "NotRequired[str]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBaseDict.url", + "target": 80, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4158, + "module": "_typeddicts", + "name": "method", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 20 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "GET" + }, + { + "type": "literal", + "value": "HEAD" + }, + { + "type": "literal", + "value": "POST" + }, + { + "type": "literal", + "value": "PUT" + }, + { + "type": "literal", + "value": "DELETE" + }, + { + "type": "literal", + "value": "CONNECT" + }, + { + "type": "literal", + "value": "OPTIONS" + }, + { + "type": "literal", + "value": "TRACE" + }, + { + "type": "literal", + "value": "PATCH" + } + ] + } + ] + }, + "inheritedFrom": { + "name": "RequestBaseDict.method", + "target": 81, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of times this request has been retried." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4159, + "module": "_typeddicts", + "name": "retry_count", + "parsedDocstring": { + "text": "The number of times this request has been retried." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 21 + } + ], + "type": { + "name": "NotRequired[int]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBaseDict.retry_count", + "target": 82, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The final URL that was loaded, after redirects (if any)." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4160, + "module": "_typeddicts", + "name": "loaded_url", + "parsedDocstring": { + "text": "The final URL that was loaded, after redirects (if any)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 25 + } + ], + "type": { + "name": "NotRequired[str | None]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBaseDict.loaded_url", + "target": 83, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The request payload, typically used with POST or PUT requests." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4161, + "module": "_typeddicts", + "name": "payload", + "parsedDocstring": { + "text": "The request payload, typically used with POST or PUT requests." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 29 + } + ], + "type": { + "name": "NotRequired[str | dict[str, Any] | None]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBaseDict.payload", + "target": 84, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP headers sent with the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4162, + "module": "_typeddicts", + "name": "headers", + "parsedDocstring": { + "text": "HTTP headers sent with the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 33 + } + ], + "type": { + "name": "NotRequired[dict[str, Any] | None]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBaseDict.headers", + "target": 85, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4163, + "module": "_typeddicts", + "name": "user_data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 37 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "dict[str, Any]" + } + ] + }, + "inheritedFrom": { + "name": "RequestBaseDict.user_data", + "target": 86, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Indicates whether the request should not be retried if processing fails." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4164, + "module": "_typeddicts", + "name": "no_retry", + "parsedDocstring": { + "text": "Indicates whether the request should not be retried if processing fails." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 38 + } + ], + "type": { + "name": "NotRequired[bool | None]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBaseDict.no_retry", + "target": 87, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error messages recorded from failed processing attempts." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4165, + "module": "_typeddicts", + "name": "error_messages", + "parsedDocstring": { + "text": "Error messages recorded from failed processing attempts." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 42 + } + ], + "type": { + "name": "NotRequired[list[str]]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBaseDict.error_messages", + "target": 88, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timestamp when the request was marked as handled, if applicable." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4166, + "module": "_typeddicts", + "name": "handled_at", + "parsedDocstring": { + "text": "The timestamp when the request was marked as handled, if applicable." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 46 + } + ], + "type": { + "name": "NotRequired[str | None]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBaseDict.handled_at", + "target": 89, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request stored in the request queue, including its metadata and processing state." + } + ] + }, + "decorations": [ + { + "args": "('Typed dicts')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4165, + 4166, + 4162, + 103, + 4160, + 4158, + 4164, + 4161, + 4159, + 4156, + 4157, + 4163 + ], + "title": "Properties" + } + ], + "id": 102, + "module": "_typeddicts", + "name": "RequestDict", + "parsedDocstring": { + "text": "A request stored in the request queue, including its metadata and processing state." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 95 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "RequestBaseDict", + "target": "78", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 105, + "module": "_typeddicts", + "name": "id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 108 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4145, + "module": "_typeddicts", + "name": "uniqueKey", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 54 + } + ], + "type": { + "name": "NotRequired[str]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBaseCamelDict.uniqueKey", + "target": 91, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4146, + "module": "_typeddicts", + "name": "url", + "parsedDocstring": { + "text": "The URL of the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 58 + } + ], + "type": { + "name": "NotRequired[str]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBaseCamelDict.url", + "target": 92, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4147, + "module": "_typeddicts", + "name": "method", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 62 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "GET" + }, + { + "type": "literal", + "value": "HEAD" + }, + { + "type": "literal", + "value": "POST" + }, + { + "type": "literal", + "value": "PUT" + }, + { + "type": "literal", + "value": "DELETE" + }, + { + "type": "literal", + "value": "CONNECT" + }, + { + "type": "literal", + "value": "OPTIONS" + }, + { + "type": "literal", + "value": "TRACE" + }, + { + "type": "literal", + "value": "PATCH" + } + ] + } + ] + }, + "inheritedFrom": { + "name": "RequestBaseCamelDict.method", + "target": 93, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of times this request has been retried." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4148, + "module": "_typeddicts", + "name": "retryCount", + "parsedDocstring": { + "text": "The number of times this request has been retried." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 63 + } + ], + "type": { + "name": "NotRequired[int]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBaseCamelDict.retryCount", + "target": 94, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The final URL that was loaded, after redirects (if any)." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4149, + "module": "_typeddicts", + "name": "loadedUrl", + "parsedDocstring": { + "text": "The final URL that was loaded, after redirects (if any)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 67 + } + ], + "type": { + "name": "NotRequired[str | None]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBaseCamelDict.loadedUrl", + "target": 95, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The request payload, typically used with POST or PUT requests." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4150, + "module": "_typeddicts", + "name": "payload", + "parsedDocstring": { + "text": "The request payload, typically used with POST or PUT requests." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 71 + } + ], + "type": { + "name": "NotRequired[str | dict[str, Any] | None]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBaseCamelDict.payload", + "target": 96, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP headers sent with the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4151, + "module": "_typeddicts", + "name": "headers", + "parsedDocstring": { + "text": "HTTP headers sent with the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 75 + } + ], + "type": { + "name": "NotRequired[dict[str, Any] | None]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBaseCamelDict.headers", + "target": 97, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4152, + "module": "_typeddicts", + "name": "userData", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 79 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "dict[str, Any]" + } + ] + }, + "inheritedFrom": { + "name": "RequestBaseCamelDict.userData", + "target": 98, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Indicates whether the request should not be retried if processing fails." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4153, + "module": "_typeddicts", + "name": "noRetry", + "parsedDocstring": { + "text": "Indicates whether the request should not be retried if processing fails." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 80 + } + ], + "type": { + "name": "NotRequired[bool | None]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBaseCamelDict.noRetry", + "target": 99, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error messages recorded from failed processing attempts." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4154, + "module": "_typeddicts", + "name": "errorMessages", + "parsedDocstring": { + "text": "Error messages recorded from failed processing attempts." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 84 + } + ], + "type": { + "name": "NotRequired[list[str]]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBaseCamelDict.errorMessages", + "target": 100, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timestamp when the request was marked as handled, if applicable." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4155, + "module": "_typeddicts", + "name": "handledAt", + "parsedDocstring": { + "text": "The timestamp when the request was marked as handled, if applicable." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 88 + } + ], + "type": { + "name": "NotRequired[str | None]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBaseCamelDict.handledAt", + "target": 101, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request stored in the request queue, including its metadata and processing state." + } + ] + }, + "decorations": [ + { + "args": "('Typed dicts')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4154, + 4155, + 4151, + 105, + 4149, + 4147, + 4153, + 4150, + 4148, + 4145, + 4146, + 4152 + ], + "title": "Properties" + } + ], + "id": 104, + "module": "_typeddicts", + "name": "RequestCamelDict", + "parsedDocstring": { + "text": "A request stored in the request queue, including its metadata and processing state." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 105 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "RequestBaseCamelDict", + "target": "90", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 107, + "module": "_typeddicts", + "name": "id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 118 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 108, + "module": "_typeddicts", + "name": "unique_key", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 122 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 109, + "module": "_typeddicts", + "name": "url", + "parsedDocstring": { + "text": "The URL of the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 126 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 110, + "module": "_typeddicts", + "name": "method", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 130 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "GET" + }, + { + "type": "literal", + "value": "HEAD" + }, + { + "type": "literal", + "value": "POST" + }, + { + "type": "literal", + "value": "PUT" + }, + { + "type": "literal", + "value": "DELETE" + }, + { + "type": "literal", + "value": "CONNECT" + }, + { + "type": "literal", + "value": "OPTIONS" + }, + { + "type": "literal", + "value": "TRACE" + }, + { + "type": "literal", + "value": "PATCH" + } + ] + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request that failed to be processed during a request queue operation and can be retried." + } + ] + }, + "decorations": [ + { + "args": "('Typed dicts')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 107, + 110, + 108, + 109 + ], + "title": "Properties" + } + ], + "id": 106, + "module": "_typeddicts", + "name": "RequestDraftDict", + "parsedDocstring": { + "text": "A request that failed to be processed during a request queue operation and can be retried." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 115 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 112, + "module": "_typeddicts", + "name": "id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 137 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 113, + "module": "_typeddicts", + "name": "uniqueKey", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 141 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 114, + "module": "_typeddicts", + "name": "url", + "parsedDocstring": { + "text": "The URL of the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 145 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 115, + "module": "_typeddicts", + "name": "method", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 149 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "GET" + }, + { + "type": "literal", + "value": "HEAD" + }, + { + "type": "literal", + "value": "POST" + }, + { + "type": "literal", + "value": "PUT" + }, + { + "type": "literal", + "value": "DELETE" + }, + { + "type": "literal", + "value": "CONNECT" + }, + { + "type": "literal", + "value": "OPTIONS" + }, + { + "type": "literal", + "value": "TRACE" + }, + { + "type": "literal", + "value": "PATCH" + } + ] + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request that failed to be processed during a request queue operation and can be retried." + } + ] + }, + "decorations": [ + { + "args": "('Typed dicts')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 112, + 115, + 113, + 114 + ], + "title": "Properties" + } + ], + "id": 111, + "module": "_typeddicts", + "name": "RequestDraftCamelDict", + "parsedDocstring": { + "text": "A request that failed to be processed during a request queue operation and can be retried." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 134 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 117, + "module": "_typeddicts", + "name": "id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 156 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 118, + "module": "_typeddicts", + "name": "unique_key", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 160 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request that should be deleted, identified by its ID." + } + ] + }, + "decorations": [ + { + "args": "('Typed dicts')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 117, + 118 + ], + "title": "Properties" + } + ], + "id": 116, + "module": "_typeddicts", + "name": "RequestDraftDeleteByIdDict", + "parsedDocstring": { + "text": "A request that should be deleted, identified by its ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 153 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 120, + "module": "_typeddicts", + "name": "id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 170 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 121, + "module": "_typeddicts", + "name": "uniqueKey", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 174 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request that should be deleted, identified by its ID." + } + ] + }, + "decorations": [ + { + "args": "('Typed dicts')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 120, + 121 + ], + "title": "Properties" + } + ], + "id": 119, + "module": "_typeddicts", + "name": "RequestDraftDeleteByIdCamelDict", + "parsedDocstring": { + "text": "A request that should be deleted, identified by its ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 167 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 123, + "module": "_typeddicts", + "name": "id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 184 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 124, + "module": "_typeddicts", + "name": "unique_key", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 188 + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request that should be deleted, identified by its unique key." + } + ] + }, + "decorations": [ + { + "args": "('Typed dicts')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 123, + 124 + ], + "title": "Properties" + } + ], + "id": 122, + "module": "_typeddicts", + "name": "RequestDraftDeleteByUniqueKeyDict", + "parsedDocstring": { + "text": "A request that should be deleted, identified by its unique key." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 181 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 126, + "module": "_typeddicts", + "name": "id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 198 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 127, + "module": "_typeddicts", + "name": "uniqueKey", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 202 + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request that should be deleted, identified by its unique key." + } + ] + }, + "decorations": [ + { + "args": "('Typed dicts')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 126, + 127 + ], + "title": "Properties" + } + ], + "id": 125, + "module": "_typeddicts", + "name": "RequestDraftDeleteByUniqueKeyCamelDict", + "parsedDocstring": { + "text": "A request that should be deleted, identified by its unique key." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 195 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request that should be deleted." + } + ] + }, + "flags": {}, + "groups": [], + "id": 128, + "module": "_typeddicts", + "name": "RequestDraftDeleteDict", + "parsedDocstring": { + "text": "A request that should be deleted." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 208 + } + ], + "type": { + "name": "TypeAlias", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request that should be deleted." + } + ] + }, + "flags": {}, + "groups": [], + "id": 129, + "module": "_typeddicts", + "name": "RequestDraftDeleteCamelDict", + "parsedDocstring": { + "text": "A request that should be deleted." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 213 + } + ], + "type": { + "name": "TypeAlias", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 130, + "module": "_typeddicts", + "name": "RequestUserDataDict", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 219 + } + ], + "type": { + "name": "TypeAlias", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 131, + "module": "_typeddicts", + "name": "RequestUserDataCamelDict", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 221 + } + ], + "type": { + "name": "TypeAlias", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 132, + "module": "_typeddicts", + "name": "TaskInputDict", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 224 + } + ], + "type": { + "name": "TypeAlias", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 133, + "module": "_typeddicts", + "name": "TaskInputCamelDict", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 226 + } + ], + "type": { + "name": "TypeAlias", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 135, + "module": "_typeddicts", + "name": "actor_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 231 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 136, + "module": "_typeddicts", + "name": "actor_task_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 232 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 137, + "module": "_typeddicts", + "name": "actor_run_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 233 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Typed dicts')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 135, + 137, + 136 + ], + "title": "Properties" + } + ], + "id": 134, + "module": "_typeddicts", + "name": "WebhookConditionDict", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 230 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 139, + "module": "_typeddicts", + "name": "actorId", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 238 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 140, + "module": "_typeddicts", + "name": "actorTaskId", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 239 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 141, + "module": "_typeddicts", + "name": "actorRunId", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 240 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Typed dicts')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 139, + 141, + 140 + ], + "title": "Properties" + } + ], + "id": 138, + "module": "_typeddicts", + "name": "WebhookConditionCamelDict", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 237 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 143, + "module": "_typeddicts", + "name": "is_ad_hoc", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 245 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 144, + "module": "_typeddicts", + "name": "event_types", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 246 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "ACTOR.BUILD.ABORTED" + }, + { + "type": "literal", + "value": "ACTOR.BUILD.CREATED" + }, + { + "type": "literal", + "value": "ACTOR.BUILD.FAILED" + }, + { + "type": "literal", + "value": "ACTOR.BUILD.SUCCEEDED" + }, + { + "type": "literal", + "value": "ACTOR.BUILD.TIMED_OUT" + }, + { + "type": "literal", + "value": "ACTOR.RUN.ABORTED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.CREATED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.FAILED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.RESURRECTED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.SUCCEEDED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.TIMED_OUT" + }, + { + "type": "literal", + "value": "TEST" + } + ] + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 145, + "module": "_typeddicts", + "name": "condition", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 262 + } + ], + "type": { + "name": "WebhookConditionDict", + "type": "reference", + "target": "134" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 146, + "module": "_typeddicts", + "name": "idempotency_key", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 263 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 147, + "module": "_typeddicts", + "name": "ignore_ssl_errors", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 264 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 148, + "module": "_typeddicts", + "name": "do_not_retry", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 265 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 149, + "module": "_typeddicts", + "name": "request_url", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 266 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 150, + "module": "_typeddicts", + "name": "payload_template", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 267 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 151, + "module": "_typeddicts", + "name": "headers_template", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 268 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 152, + "module": "_typeddicts", + "name": "description", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 269 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 153, + "module": "_typeddicts", + "name": "should_interpolate_strings", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 270 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Typed dicts')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 145, + 152, + 148, + 144, + 151, + 146, + 147, + 143, + 150, + 149, + 153 + ], + "title": "Properties" + } + ], + "id": 142, + "module": "_typeddicts", + "name": "WebhookCreateDict", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 244 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 155, + "module": "_typeddicts", + "name": "isAdHoc", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 275 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 156, + "module": "_typeddicts", + "name": "eventTypes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 276 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "ACTOR.BUILD.ABORTED" + }, + { + "type": "literal", + "value": "ACTOR.BUILD.CREATED" + }, + { + "type": "literal", + "value": "ACTOR.BUILD.FAILED" + }, + { + "type": "literal", + "value": "ACTOR.BUILD.SUCCEEDED" + }, + { + "type": "literal", + "value": "ACTOR.BUILD.TIMED_OUT" + }, + { + "type": "literal", + "value": "ACTOR.RUN.ABORTED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.CREATED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.FAILED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.RESURRECTED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.SUCCEEDED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.TIMED_OUT" + }, + { + "type": "literal", + "value": "TEST" + } + ] + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 157, + "module": "_typeddicts", + "name": "condition", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 292 + } + ], + "type": { + "name": "WebhookConditionCamelDict", + "type": "reference", + "target": "138" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 158, + "module": "_typeddicts", + "name": "idempotencyKey", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 293 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 159, + "module": "_typeddicts", + "name": "ignoreSslErrors", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 294 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 160, + "module": "_typeddicts", + "name": "doNotRetry", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 295 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 161, + "module": "_typeddicts", + "name": "requestUrl", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 296 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 162, + "module": "_typeddicts", + "name": "payloadTemplate", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 297 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 163, + "module": "_typeddicts", + "name": "headersTemplate", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 298 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 164, + "module": "_typeddicts", + "name": "description", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 299 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 165, + "module": "_typeddicts", + "name": "shouldInterpolateStrings", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 300 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Typed dicts')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 157, + 164, + 160, + 156, + 163, + 158, + 159, + 155, + 162, + 161, + 165 + ], + "title": "Properties" + } + ], + "id": 154, + "module": "_typeddicts", + "name": "WebhookCreateCamelDict", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 274 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 167, + "module": "_typeddicts", + "name": "event_types", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 311 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "ACTOR.BUILD.ABORTED" + }, + { + "type": "literal", + "value": "ACTOR.BUILD.CREATED" + }, + { + "type": "literal", + "value": "ACTOR.BUILD.FAILED" + }, + { + "type": "literal", + "value": "ACTOR.BUILD.SUCCEEDED" + }, + { + "type": "literal", + "value": "ACTOR.BUILD.TIMED_OUT" + }, + { + "type": "literal", + "value": "ACTOR.RUN.ABORTED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.CREATED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.FAILED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.RESURRECTED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.SUCCEEDED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.TIMED_OUT" + }, + { + "type": "literal", + "value": "TEST" + } + ] + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL to which the webhook sends its payload." + } + ] + }, + "flags": {}, + "groups": [], + "id": 168, + "module": "_typeddicts", + "name": "request_url", + "parsedDocstring": { + "text": "The URL to which the webhook sends its payload." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 327 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional template for the JSON payload sent by the webhook." + } + ] + }, + "flags": {}, + "groups": [], + "id": 169, + "module": "_typeddicts", + "name": "payload_template", + "parsedDocstring": { + "text": "Optional template for the JSON payload sent by the webhook." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 331 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional template for the HTTP headers sent by the webhook." + } + ] + }, + "flags": {}, + "groups": [], + "id": 170, + "module": "_typeddicts", + "name": "headers_template", + "parsedDocstring": { + "text": "Optional template for the HTTP headers sent by the webhook." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 335 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here." + } + ] + }, + "decorations": [ + { + "args": "('Typed dicts')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 167, + 170, + 169, + 168 + ], + "title": "Properties" + } + ], + "id": 166, + "module": "_typeddicts", + "name": "WebhookRepresentationDict", + "parsedDocstring": { + "text": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 304 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 172, + "module": "_typeddicts", + "name": "eventTypes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 349 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "ACTOR.BUILD.ABORTED" + }, + { + "type": "literal", + "value": "ACTOR.BUILD.CREATED" + }, + { + "type": "literal", + "value": "ACTOR.BUILD.FAILED" + }, + { + "type": "literal", + "value": "ACTOR.BUILD.SUCCEEDED" + }, + { + "type": "literal", + "value": "ACTOR.BUILD.TIMED_OUT" + }, + { + "type": "literal", + "value": "ACTOR.RUN.ABORTED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.CREATED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.FAILED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.RESURRECTED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.SUCCEEDED" + }, + { + "type": "literal", + "value": "ACTOR.RUN.TIMED_OUT" + }, + { + "type": "literal", + "value": "TEST" + } + ] + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL to which the webhook sends its payload." + } + ] + }, + "flags": {}, + "groups": [], + "id": 173, + "module": "_typeddicts", + "name": "requestUrl", + "parsedDocstring": { + "text": "The URL to which the webhook sends its payload." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 365 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional template for the JSON payload sent by the webhook." + } + ] + }, + "flags": {}, + "groups": [], + "id": 174, + "module": "_typeddicts", + "name": "payloadTemplate", + "parsedDocstring": { + "text": "Optional template for the JSON payload sent by the webhook." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 369 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional template for the HTTP headers sent by the webhook." + } + ] + }, + "flags": {}, + "groups": [], + "id": 175, + "module": "_typeddicts", + "name": "headersTemplate", + "parsedDocstring": { + "text": "Optional template for the HTTP headers sent by the webhook." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 373 + } + ], + "type": { + "name": "NotRequired", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here." + } + ] + }, + "decorations": [ + { + "args": "('Typed dicts')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 172, + 175, + 174, + 173 + ], + "title": "Properties" + } + ], + "id": 171, + "module": "_typeddicts", + "name": "WebhookRepresentationCamelDict", + "parsedDocstring": { + "text": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_typeddicts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 342 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default base URL for the Apify API." + } + ] + }, + "flags": {}, + "groups": [], + "id": 176, + "module": "_consts", + "name": "DEFAULT_API_URL", + "parsedDocstring": { + "text": "Default base URL for the Apify API." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_consts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 5 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Current Apify API version." + } + ] + }, + "flags": {}, + "groups": [], + "id": 177, + "module": "_consts", + "name": "API_VERSION", + "parsedDocstring": { + "text": "Current Apify API version." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_consts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 8 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for fast CRUD operations (e.g., get, update, delete)." + } + ] + }, + "flags": {}, + "groups": [], + "id": 178, + "module": "_consts", + "name": "DEFAULT_TIMEOUT_SHORT", + "parsedDocstring": { + "text": "Default timeout for fast CRUD operations (e.g., get, update, delete)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_consts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 11 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for batch, list, and data transfer operations." + } + ] + }, + "flags": {}, + "groups": [], + "id": 179, + "module": "_consts", + "name": "DEFAULT_TIMEOUT_MEDIUM", + "parsedDocstring": { + "text": "Default timeout for batch, list, and data transfer operations." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_consts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 14 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for long-polling, streaming, and other heavy operations." + } + ] + }, + "flags": {}, + "groups": [], + "id": 180, + "module": "_consts", + "name": "DEFAULT_TIMEOUT_LONG", + "parsedDocstring": { + "text": "Default timeout for long-polling, streaming, and other heavy operations." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_consts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 17 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default maximum timeout cap for individual API requests (limits exponential growth)." + } + ] + }, + "flags": {}, + "groups": [], + "id": 181, + "module": "_consts", + "name": "DEFAULT_TIMEOUT_MAX", + "parsedDocstring": { + "text": "Default maximum timeout cap for individual API requests (limits exponential growth)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_consts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 20 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default maximum number of retries for failed requests." + } + ] + }, + "flags": {}, + "groups": [], + "id": 182, + "module": "_consts", + "name": "DEFAULT_MAX_RETRIES", + "parsedDocstring": { + "text": "Default maximum number of retries for failed requests." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_consts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 23 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default minimum delay between retries." + } + ] + }, + "flags": {}, + "groups": [], + "id": 183, + "module": "_consts", + "name": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES", + "parsedDocstring": { + "text": "Default minimum delay between retries." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_consts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 26 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default maximum wait time for job completion (effectively infinite)." + } + ] + }, + "flags": {}, + "groups": [], + "id": 184, + "module": "_consts", + "name": "DEFAULT_WAIT_FOR_FINISH", + "parsedDocstring": { + "text": "Default maximum wait time for job completion (effectively infinite)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_consts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 29 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "How long to wait for a job to exist before giving up." + } + ] + }, + "flags": {}, + "groups": [], + "id": 185, + "module": "_consts", + "name": "DEFAULT_WAIT_WHEN_JOB_NOT_EXIST", + "parsedDocstring": { + "text": "How long to wait for a job to exist before giving up." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_consts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 32 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers that can be overridden by users, but will trigger a warning if they do so, as it may lead to API errors." + } + ] + }, + "flags": {}, + "groups": [], + "id": 186, + "module": "_consts", + "name": "OVERRIDABLE_DEFAULT_HEADERS", + "parsedDocstring": { + "text": "Headers that can be overridden by users, but will trigger a warning if they do so, as it may lead to API errors." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_consts.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 35 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 188, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 26 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 189, + "module": "_models", + "name": "monthly_usage_cycle", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 30 + } + ], + "type": { + "name": "UsageCycle", + "type": "reference", + "target": "1303" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 190, + "module": "_models", + "name": "limits", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 31 + } + ], + "type": { + "name": "Limits", + "type": "reference", + "target": "629" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 191, + "module": "_models", + "name": "current", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 32 + } + ], + "type": { + "name": "Current", + "type": "reference", + "target": "412" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 191, + 190, + 188, + 189 + ], + "title": "Properties" + } + ], + "id": 187, + "module": "_models", + "name": "AccountLimits", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 25 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 193, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 37 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 194, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 41 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 195, + "module": "_models", + "name": "user_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 42 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 196, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 43 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 197, + "module": "_models", + "name": "username", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 44 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 198, + "module": "_models", + "name": "description", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 45 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['My favourite actor!'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 199, + "module": "_models", + "name": "restart_on_error", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 46 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='restartOnError', deprecated=True, examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 200, + "module": "_models", + "name": "is_public", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 47 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 201, + "module": "_models", + "name": "actor_permission_level", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 48 + } + ], + "type": { + "name": "Annotated[ActorPermissionLevel | None, Field(alias='actorPermissionLevel')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorPermissionLevel", + "target": "1795" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 202, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 49 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 203, + "module": "_models", + "name": "modified_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 50 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 204, + "module": "_models", + "name": "stats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 51 + } + ], + "type": { + "name": "ActorStats", + "type": "reference", + "target": "265" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 205, + "module": "_models", + "name": "versions", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 52 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Version", + "target": "1336" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 206, + "module": "_models", + "name": "pricing_infos", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 53 + } + ], + "type": { + "name": "Annotated[ list[ Annotated[ PayPerEventActorPricingInfo | PricePerDatasetItemActorPricingInfo | FlatPricePerMonthActorPricingInfo | FreeActorPricingInfo, Field(discriminator='pricing_model'), ] ] | None, Field(alias='pricingInfos'), ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "PayPerEventActorPricingInfo", + "target": "786" + }, + { + "type": "reference", + "name": "PricePerDatasetItemActorPricingInfo", + "target": "813" + } + ] + }, + { + "type": "reference", + "name": "FlatPricePerMonthActorPricingInfo", + "target": "570" + } + ] + }, + { + "type": "reference", + "name": "FreeActorPricingInfo", + "target": "575" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 207, + "module": "_models", + "name": "default_run_options", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 66 + } + ], + "type": { + "name": "DefaultRunOptions", + "type": "reference", + "target": "499" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 208, + "module": "_models", + "name": "example_run_input", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 67 + } + ], + "type": { + "name": "Annotated[ExampleRunInput | None, Field(alias='exampleRunInput')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ExampleRunInput", + "target": "562" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 209, + "module": "_models", + "name": "is_deprecated", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 68 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='isDeprecated', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 210, + "module": "_models", + "name": "deployment_key", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 69 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='deploymentKey', examples=['ssh-rsa AAAA ...'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 211, + "module": "_models", + "name": "title", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 70 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['My Actor'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 212, + "module": "_models", + "name": "tagged_builds", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 71 + } + ], + "type": { + "name": "Annotated[dict[str, TaggedBuildInfo | None] | None, Field(alias='taggedBuilds')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "TaggedBuildInfo", + "target": "1192" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 213, + "module": "_models", + "name": "actor_standby", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "Annotated[ActorStandby | None, Field(alias='actorStandby')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorStandby", + "target": "255" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A brief, LLM-generated readme summary" + } + ] + }, + "flags": {}, + "groups": [], + "id": 214, + "module": "_models", + "name": "readme_summary", + "parsedDocstring": { + "text": "A brief, LLM-generated readme summary" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 73 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='readmeSummary')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 201, + 213, + 202, + 207, + 210, + 198, + 208, + 194, + 209, + 200, + 193, + 203, + 196, + 206, + 214, + 199, + 204, + 212, + 211, + 195, + 197, + 205 + ], + "title": "Properties" + } + ], + "id": 192, + "module": "_models", + "name": "Actor", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 36 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 216, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 81 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 217, + "module": "_models", + "name": "event_price_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 85 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 218, + "module": "_models", + "name": "event_title", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 86 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 219, + "module": "_models", + "name": "event_description", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 87 + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 219, + 217, + 218, + 216 + ], + "title": "Properties" + } + ], + "id": 215, + "module": "_models", + "name": "ActorChargeEvent", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 80 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 221, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 94 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Actor specification version that this Actor follows. This property must be set to 1." + } + ] + }, + "flags": {}, + "groups": [], + "id": 222, + "module": "_models", + "name": "actor_specification", + "parsedDocstring": { + "text": "The Actor specification version that this Actor follows. This property must be set to 1." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 98 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": 1 + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the Actor." + } + ] + }, + "flags": {}, + "groups": [], + "id": 223, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "The name of the Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 102 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The version of the Actor, specified in the format [Number].[Number], e.g., 0.1, 1.0." + } + ] + }, + "flags": {}, + "groups": [], + "id": 224, + "module": "_models", + "name": "version", + "parsedDocstring": { + "text": "The version of the Actor, specified in the format [Number].[Number], e.g., 0.1, 1.0." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 106 + } + ], + "type": { + "name": "Annotated[str | None, Field(pattern='^[0-9]+\\\\.[0-9]+$')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tag name to be applied to a successful build of the Actor. Defaults to 'latest' if not specified." + } + ] + }, + "flags": {}, + "groups": [], + "id": 225, + "module": "_models", + "name": "build_tag", + "parsedDocstring": { + "text": "The tag name to be applied to a successful build of the Actor. Defaults to 'latest' if not specified." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 110 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='buildTag')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A map of environment variables to be used during local development and deployment." + } + ] + }, + "flags": {}, + "groups": [], + "id": 226, + "module": "_models", + "name": "environment_variables", + "parsedDocstring": { + "text": "A map of environment variables to be used during local development and deployment." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 114 + } + ], + "type": { + "name": "Annotated[dict[str, str] | None, Field(alias='environmentVariables')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "str" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The path to the Dockerfile used for building the Actor on the platform." + } + ] + }, + "flags": {}, + "groups": [], + "id": 227, + "module": "_models", + "name": "dockerfile", + "parsedDocstring": { + "text": "The path to the Dockerfile used for building the Actor on the platform." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 118 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The path to the directory used as the Docker context when building the Actor." + } + ] + }, + "flags": {}, + "groups": [], + "id": 228, + "module": "_models", + "name": "docker_context_dir", + "parsedDocstring": { + "text": "The path to the directory used as the Docker context when building the Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 122 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='dockerContextDir')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The path to the README file for the Actor." + } + ] + }, + "flags": {}, + "groups": [], + "id": 229, + "module": "_models", + "name": "readme", + "parsedDocstring": { + "text": "The path to the README file for the Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 126 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The input schema object, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/input-schema)" + } + ] + }, + "flags": {}, + "groups": [], + "id": 230, + "module": "_models", + "name": "input", + "parsedDocstring": { + "text": "The input schema object, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/input-schema)" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 130 + } + ], + "type": { + "name": "dict[str, Any] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The path to the CHANGELOG file displayed in the Actor's information tab." + } + ] + }, + "flags": {}, + "groups": [], + "id": 231, + "module": "_models", + "name": "changelog", + "parsedDocstring": { + "text": "The path to the CHANGELOG file displayed in the Actor's information tab." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 134 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 232, + "module": "_models", + "name": "storages", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 138 + } + ], + "type": { + "name": "Storages | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Storages", + "target": "1172" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the default amount of memory in megabytes to be used when the Actor is started. Can be an integer or a [dynamic memory expression](/platform/actors/development/actor-definition/dynamic-actor-memory)." + } + ] + }, + "flags": {}, + "groups": [], + "id": 233, + "module": "_models", + "name": "default_memory_mbytes", + "parsedDocstring": { + "text": "Specifies the default amount of memory in megabytes to be used when the Actor is started. Can be an integer or a [dynamic memory expression](/platform/actors/development/actor-definition/dynamic-actor-memory)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 139 + } + ], + "type": { + "name": "Annotated[str | int | None, Field(alias='defaultMemoryMbytes')]", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "int" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the minimum amount of memory in megabytes required by the Actor." + } + ] + }, + "flags": {}, + "groups": [], + "id": 234, + "module": "_models", + "name": "min_memory_mbytes", + "parsedDocstring": { + "text": "Specifies the minimum amount of memory in megabytes required by the Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 143 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='minMemoryMbytes', ge=256)]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the maximum amount of memory in megabytes required by the Actor." + } + ] + }, + "flags": {}, + "groups": [], + "id": 235, + "module": "_models", + "name": "max_memory_mbytes", + "parsedDocstring": { + "text": "Specifies the maximum amount of memory in megabytes required by the Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 147 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='maxMemoryMbytes', ge=256)]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies whether Standby mode is enabled for the Actor." + } + ] + }, + "flags": {}, + "groups": [], + "id": 236, + "module": "_models", + "name": "uses_standby_mode", + "parsedDocstring": { + "text": "Specifies whether Standby mode is enabled for the Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 151 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='usesStandbyMode')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The definition of the Actor, the full specification of this field can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/actor-json)." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 222, + 225, + 231, + 233, + 228, + 227, + 226, + 230, + 235, + 234, + 221, + 223, + 229, + 232, + 236, + 224 + ], + "title": "Properties" + } + ], + "id": 220, + "module": "_models", + "name": "ActorDefinition", + "parsedDocstring": { + "text": "The definition of the Actor, the full specification of this field can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/actor-json)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 91 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 238, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 161 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 239, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 165 + } + ], + "type": { + "name": "Actor", + "type": "reference", + "target": "192" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response containing Actor data." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 239, + 238 + ], + "title": "Properties" + } + ], + "id": 237, + "module": "_models", + "name": "ActorResponse", + "parsedDocstring": { + "text": "Response containing Actor data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 158 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 241, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 170 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 242, + "module": "_models", + "name": "error", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 174 + } + ], + "type": { + "name": "RunFailedErrorDetail | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "RunFailedErrorDetail", + "target": "989" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 242, + 241 + ], + "title": "Properties" + } + ], + "id": 240, + "module": "_models", + "name": "ActorRunFailedError", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 169 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 244, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 179 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 245, + "module": "_models", + "name": "error", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 183 + } + ], + "type": { + "name": "RunTimeoutExceededErrorDetail | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "RunTimeoutExceededErrorDetail", + "target": "1044" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 245, + 244 + ], + "title": "Properties" + } + ], + "id": 243, + "module": "_models", + "name": "ActorRunTimeoutExceededError", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 178 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 247, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 188 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 248, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 192 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 249, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 193 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 250, + "module": "_models", + "name": "modified_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 194 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 251, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 195 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 252, + "module": "_models", + "name": "username", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 196 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 253, + "module": "_models", + "name": "title", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 197 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['Hello World Example'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 254, + "module": "_models", + "name": "stats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 198 + } + ], + "type": { + "name": "ActorStats | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorStats", + "target": "265" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 249, + 248, + 247, + 250, + 251, + 254, + 253, + 252 + ], + "title": "Properties" + } + ], + "id": 246, + "module": "_models", + "name": "ActorShort", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 187 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 256, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 203 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 257, + "module": "_models", + "name": "is_enabled", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 207 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='isEnabled')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 258, + "module": "_models", + "name": "desired_requests_per_actor_run", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 208 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='desiredRequestsPerActorRun')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 259, + "module": "_models", + "name": "max_requests_per_actor_run", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 209 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='maxRequestsPerActorRun')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 260, + "module": "_models", + "name": "idle_timeout_secs", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 210 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='idleTimeoutSecs')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 261, + "module": "_models", + "name": "build", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 211 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 262, + "module": "_models", + "name": "memory_mbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 212 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='memoryMbytes')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 263, + "module": "_models", + "name": "disable_standby_fields_override", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 213 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='disableStandbyFieldsOverride')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 264, + "module": "_models", + "name": "should_pass_actor_input", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 214 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='shouldPassActorInput')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 261, + 258, + 263, + 260, + 257, + 259, + 262, + 256, + 264 + ], + "title": "Properties" + } + ], + "id": 255, + "module": "_models", + "name": "ActorStandby", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 202 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 266, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 219 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 267, + "module": "_models", + "name": "total_builds", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 223 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='totalBuilds', examples=[9])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 268, + "module": "_models", + "name": "total_runs", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 224 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='totalRuns', examples=[16])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 269, + "module": "_models", + "name": "total_users", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 225 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='totalUsers', examples=[6])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 270, + "module": "_models", + "name": "total_users7_days", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 226 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='totalUsers7Days', examples=[2])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 271, + "module": "_models", + "name": "total_users30_days", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 227 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='totalUsers30Days', examples=[6])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 272, + "module": "_models", + "name": "total_users90_days", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 228 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='totalUsers90Days', examples=[6])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 273, + "module": "_models", + "name": "total_metamorphs", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 229 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='totalMetamorphs', examples=[2])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 274, + "module": "_models", + "name": "last_run_started_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 230 + } + ], + "type": { + "name": "Annotated[ AwareDatetime | None, Field(alias='lastRunStartedAt', examples=['2019-07-08T14:01:05.546Z']) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 274, + 266, + 267, + 273, + 268, + 269, + 271, + 270, + 272 + ], + "title": "Properties" + } + ], + "id": 265, + "module": "_models", + "name": "ActorStats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 218 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 276, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 239 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 277, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 243 + } + ], + "type": { + "name": "RequestRegistration", + "type": "reference", + "target": "948" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response containing the result of adding a request to the request queue." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 277, + 276 + ], + "title": "Properties" + } + ], + "id": 275, + "module": "_models", + "name": "AddRequestResponse", + "parsedDocstring": { + "text": "Response containing the result of adding a request to the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 236 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 279, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 250 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 280, + "module": "_models", + "name": "request_id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 254 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 281, + "module": "_models", + "name": "unique_key", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 258 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Indicates whether a request with the same unique key already existed in the request queue. If true, no new request was created." + } + ] + }, + "flags": {}, + "groups": [], + "id": 282, + "module": "_models", + "name": "was_already_present", + "parsedDocstring": { + "text": "Indicates whether a request with the same unique key already existed in the request queue. If true, no new request was created." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 262 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Indicates whether a request with the same unique key has already been processed by the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 283, + "module": "_models", + "name": "was_already_handled", + "parsedDocstring": { + "text": "Indicates whether a request with the same unique key has already been processed by the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 266 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Information about a request that was successfully added to a request queue." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 279, + 280, + 281, + 283, + 282 + ], + "title": "Properties" + } + ], + "id": 278, + "module": "_models", + "name": "AddedRequest", + "parsedDocstring": { + "text": "Information about a request that was successfully added to a request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 247 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 285, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 276 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 286, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 280 + } + ], + "type": { + "name": "BatchAddResult", + "type": "reference", + "target": "287" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response containing the result of a batch add operation." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 286, + 285 + ], + "title": "Properties" + } + ], + "id": 284, + "module": "_models", + "name": "BatchAddResponse", + "parsedDocstring": { + "text": "Response containing the result of a batch add operation." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 273 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 288, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 287 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Requests that were successfully added to the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 289, + "module": "_models", + "name": "processed_requests", + "parsedDocstring": { + "text": "Requests that were successfully added to the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 291 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "AddedRequest", + "target": "278" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Requests that failed to be added and can be retried." + } + ] + }, + "flags": {}, + "groups": [], + "id": 290, + "module": "_models", + "name": "unprocessed_requests", + "parsedDocstring": { + "text": "Requests that failed to be added and can be retried." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 295 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "RequestDraft", + "target": "879" + } + ], + "target": "2199" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Result of a batch add operation containing successfully processed and failed requests." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 288, + 289, + 290 + ], + "title": "Properties" + } + ], + "id": 287, + "module": "_models", + "name": "BatchAddResult", + "parsedDocstring": { + "text": "Result of a batch add operation containing successfully processed and failed requests." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 284 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 292, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 305 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 293, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 309 + } + ], + "type": { + "name": "BatchDeleteResult", + "type": "reference", + "target": "294" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response containing the result of a batch delete operation." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 293, + 292 + ], + "title": "Properties" + } + ], + "id": 291, + "module": "_models", + "name": "BatchDeleteResponse", + "parsedDocstring": { + "text": "Response containing the result of a batch delete operation." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 302 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 295, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 316 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Requests that were successfully deleted from the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 296, + "module": "_models", + "name": "processed_requests", + "parsedDocstring": { + "text": "Requests that were successfully deleted from the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 320 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "DeletedRequestById", + "target": "507" + }, + { + "type": "reference", + "name": "DeletedRequestByUniqueKey", + "target": "511" + } + ] + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Requests that failed to be deleted and can be retried." + } + ] + }, + "flags": {}, + "groups": [], + "id": 297, + "module": "_models", + "name": "unprocessed_requests", + "parsedDocstring": { + "text": "Requests that failed to be deleted and can be retried." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 326 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "RequestDraft", + "target": "879" + } + ], + "target": "2199" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Result of a batch delete operation containing successfully deleted and failed requests." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 295, + 296, + 297 + ], + "title": "Properties" + } + ], + "id": 294, + "module": "_models", + "name": "BatchDeleteResult", + "parsedDocstring": { + "text": "Result of a batch delete operation containing successfully deleted and failed requests." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 313 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 299, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 334 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP method of the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 300, + "module": "_models", + "name": "method", + "parsedDocstring": { + "text": "HTTP method of the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 338 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "IP address of the client." + } + ] + }, + "flags": {}, + "groups": [], + "id": 301, + "module": "_models", + "name": "client_ip", + "parsedDocstring": { + "text": "IP address of the client." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 342 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='clientIp', examples=['1.2.3.4'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Two-letter country code resolved from the client IP address." + } + ] + }, + "flags": {}, + "groups": [], + "id": 302, + "module": "_models", + "name": "country_code", + "parsedDocstring": { + "text": "Two-letter country code resolved from the client IP address." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 346 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='countryCode', examples=['US'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Length of the request body in bytes." + } + ] + }, + "flags": {}, + "groups": [], + "id": 303, + "module": "_models", + "name": "body_length", + "parsedDocstring": { + "text": "Length of the request body in bytes." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 350 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Request headers. Omitted when `skipHeaders=true`." + } + ] + }, + "flags": {}, + "groups": [], + "id": 304, + "module": "_models", + "name": "headers", + "parsedDocstring": { + "text": "Request headers. Omitted when `skipHeaders=true`." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 354 + } + ], + "type": { + "name": "dict[str, str | list[str]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + } + ] + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Raw request headers as a flat list of alternating name/value strings.\nIncluded only when `rawHeaders=true`." + } + ] + }, + "flags": {}, + "groups": [], + "id": 305, + "module": "_models", + "name": "raw_headers", + "parsedDocstring": { + "text": "Raw request headers as a flat list of alternating name/value strings.\nIncluded only when `rawHeaders=true`." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 359 + } + ], + "type": { + "name": "Annotated[list[str] | None, Field(alias='rawHeaders')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 303, + 301, + 302, + 304, + 300, + 299, + 305 + ], + "title": "Properties" + } + ], + "id": 298, + "module": "_models", + "name": "BrowserInfoResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 333 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 307, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 369 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 308, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 373 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 309, + "module": "_models", + "name": "act_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 374 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 310, + "module": "_models", + "name": "user_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 375 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 311, + "module": "_models", + "name": "started_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 376 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 312, + "module": "_models", + "name": "finished_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 377 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 313, + "module": "_models", + "name": "status", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 380 + } + ], + "type": { + "name": "ActorJobStatus", + "type": "reference", + "target": "1794" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 314, + "module": "_models", + "name": "meta", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 381 + } + ], + "type": { + "name": "BuildsMeta", + "type": "reference", + "target": "353" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 315, + "module": "_models", + "name": "stats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 382 + } + ], + "type": { + "name": "BuildStats | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "BuildStats", + "target": "342" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 316, + "module": "_models", + "name": "options", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 383 + } + ], + "type": { + "name": "BuildOptions | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "BuildOptions", + "target": "324" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 317, + "module": "_models", + "name": "usage", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 384 + } + ], + "type": { + "name": "BuildUsage | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "BuildUsage", + "target": "350" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Total cost in USD for this build. Requires authentication token to access." + } + ] + }, + "flags": {}, + "groups": [], + "id": 318, + "module": "_models", + "name": "usage_total_usd", + "parsedDocstring": { + "text": "Total cost in USD for this build. Requires authentication token to access." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 385 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='usageTotalUsd', examples=[0.02])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Platform usage costs breakdown in USD for this build. Requires authentication token to access." + } + ] + }, + "flags": {}, + "groups": [], + "id": 319, + "module": "_models", + "name": "usage_usd", + "parsedDocstring": { + "text": "Platform usage costs breakdown in USD for this build. Requires authentication token to access." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 389 + } + ], + "type": { + "name": "Annotated[BuildUsage | None, Field(alias='usageUsd')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "BuildUsage", + "target": "350" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 320, + "module": "_models", + "name": "input_schema", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 393 + } + ], + "type": { + "name": "Annotated[ str | None, Field(alias='inputSchema', deprecated=True, examples=['{\\\\n \"title\": \"Schema for ... }']) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 321, + "module": "_models", + "name": "readme", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 396 + } + ], + "type": { + "name": "Annotated[str | None, Field(deprecated=True, examples=['", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 322, + "module": "_models", + "name": "build_number", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 397 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 323, + "module": "_models", + "name": "actor_definition", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 398 + } + ], + "type": { + "name": "Annotated[ActorDefinition | None, Field(alias='actorDefinition')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorDefinition", + "target": "220" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 309, + 323, + 322, + 312, + 308, + 320, + 314, + 307, + 316, + 321, + 311, + 315, + 313, + 317, + 318, + 319, + 310 + ], + "title": "Properties" + } + ], + "id": 306, + "module": "_models", + "name": "Build", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 368 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 325, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 403 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 326, + "module": "_models", + "name": "use_cache", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 407 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='useCache', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 327, + "module": "_models", + "name": "beta_packages", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 408 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='betaPackages', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 328, + "module": "_models", + "name": "memory_mbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 409 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='memoryMbytes', examples=[1024])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 329, + "module": "_models", + "name": "disk_mbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 410 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='diskMbytes', examples=[2048])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 327, + 329, + 328, + 325, + 326 + ], + "title": "Properties" + } + ], + "id": 324, + "module": "_models", + "name": "BuildOptions", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 402 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 331, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 417 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 332, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 421 + } + ], + "type": { + "name": "Build", + "type": "reference", + "target": "306" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response containing Actor build data." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 332, + 331 + ], + "title": "Properties" + } + ], + "id": 330, + "module": "_models", + "name": "BuildResponse", + "parsedDocstring": { + "text": "Response containing Actor build data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 414 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 334, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 426 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 335, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 430 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 336, + "module": "_models", + "name": "act_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 431 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='actId', examples=['janedoe~my-actor'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 337, + "module": "_models", + "name": "status", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 432 + } + ], + "type": { + "name": "ActorJobStatus", + "type": "reference", + "target": "1794" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 338, + "module": "_models", + "name": "started_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 433 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 339, + "module": "_models", + "name": "finished_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 434 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 340, + "module": "_models", + "name": "usage_total_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 437 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 341, + "module": "_models", + "name": "meta", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 438 + } + ], + "type": { + "name": "BuildsMeta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "BuildsMeta", + "target": "353" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 336, + 339, + 335, + 341, + 334, + 338, + 337, + 340 + ], + "title": "Properties" + } + ], + "id": 333, + "module": "_models", + "name": "BuildShort", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 425 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 343, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 443 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 344, + "module": "_models", + "name": "duration_millis", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 447 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='durationMillis', examples=[1000])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 345, + "module": "_models", + "name": "run_time_secs", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 448 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='runTimeSecs', examples=[45.718])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 346, + "module": "_models", + "name": "compute_units", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 449 + } + ], + "type": { + "name": "float", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 346, + 344, + 343, + 345 + ], + "title": "Properties" + } + ], + "id": 342, + "module": "_models", + "name": "BuildStats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 442 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 348, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 454 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 349, + "module": "_models", + "name": "build_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 458 + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 349, + 348 + ], + "title": "Properties" + } + ], + "id": 347, + "module": "_models", + "name": "BuildTag", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 453 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 351, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 463 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 352, + "module": "_models", + "name": "actor_compute_units", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 467 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='ACTOR_COMPUTE_UNITS', examples=[0.08])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 352, + 351 + ], + "title": "Properties" + } + ], + "id": 350, + "module": "_models", + "name": "BuildUsage", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 462 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 354, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 472 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 355, + "module": "_models", + "name": "origin", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 476 + } + ], + "type": { + "name": "RunOrigin", + "type": "reference", + "target": "1799" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "IP address of the client that started the build." + } + ] + }, + "flags": {}, + "groups": [], + "id": 356, + "module": "_models", + "name": "client_ip", + "parsedDocstring": { + "text": "IP address of the client that started the build." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 477 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='clientIp', examples=['172.234.12.34'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "User agent of the client that started the build." + } + ] + }, + "flags": {}, + "groups": [], + "id": 357, + "module": "_models", + "name": "user_agent", + "parsedDocstring": { + "text": "User agent of the client that started the build." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 481 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='userAgent', examples=['Mozilla/5.0 (iPad)'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 356, + 354, + 355, + 357 + ], + "title": "Properties" + } + ], + "id": 353, + "module": "_models", + "name": "BuildsMeta", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 471 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 359, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 489 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 360, + "module": "_models", + "name": "started_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 493 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='startedAt', examples=['2019-12-12T07:34:14.202Z'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 361, + "module": "_models", + "name": "finished_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 494 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-12T07:34:14.202Z'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 362, + "module": "_models", + "name": "error_message", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 497 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='errorMessage', examples=['Cannot send request'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 363, + "module": "_models", + "name": "response_status", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 498 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='responseStatus', examples=[200])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 364, + "module": "_models", + "name": "response_body", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 499 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='responseBody', examples=['{\"foo\": \"bar\"}'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 362, + 361, + 359, + 364, + 363, + 360 + ], + "title": "Properties" + } + ], + "id": 358, + "module": "_models", + "name": "Call", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 488 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 366, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 504 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 367, + "module": "_models", + "name": "event_name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 508 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 368, + "module": "_models", + "name": "count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 509 + } + ], + "type": { + "name": "int", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 368, + 367, + 366 + ], + "title": "Properties" + } + ], + "id": 365, + "module": "_models", + "name": "ChargeRunRequest", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 503 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 370, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 514 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" + } + ] + }, + "flags": {}, + "groups": [], + "id": 371, + "module": "_models", + "name": "apify_margin_percentage", + "parsedDocstring": { + "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 518 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "When this pricing info record has been created" + } + ] + }, + "flags": {}, + "groups": [], + "id": 372, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "When this pricing info record has been created" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 522 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Since when is this pricing info record effective for a given Actor" + } + ] + }, + "flags": {}, + "groups": [], + "id": 373, + "module": "_models", + "name": "started_at", + "parsedDocstring": { + "text": "Since when is this pricing info record effective for a given Actor" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 526 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 374, + "module": "_models", + "name": "notified_about_future_change_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 530 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutFutureChangeAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 375, + "module": "_models", + "name": "notified_about_change_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 531 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutChangeAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 376, + "module": "_models", + "name": "reason_for_change", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 532 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='reasonForChange')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 371, + 372, + 370, + 375, + 374, + 376, + 373 + ], + "title": "Properties" + } + ], + "id": 369, + "module": "_models", + "name": "CommonActorPricingInfo", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 513 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "FlatPricePerMonthActorPricingInfo", + "target": "570", + "type": "reference" + }, + { + "name": "FreeActorPricingInfo", + "target": "575", + "type": "reference" + }, + { + "name": "PayPerEventActorPricingInfo", + "target": "786", + "type": "reference" + }, + { + "name": "PricePerDatasetItemActorPricingInfo", + "target": "813", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 378, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 537 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 379, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 541 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['MyActor'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 380, + "module": "_models", + "name": "description", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 542 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['My favourite actor!'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 381, + "module": "_models", + "name": "title", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 543 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['My actor'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 382, + "module": "_models", + "name": "is_public", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 544 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='isPublic', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 383, + "module": "_models", + "name": "seo_title", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 545 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='seoTitle', examples=['My actor'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 384, + "module": "_models", + "name": "seo_description", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 546 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='seoDescription', examples=['My actor is the best'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 385, + "module": "_models", + "name": "restart_on_error", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 547 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='restartOnError', deprecated=True, examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 386, + "module": "_models", + "name": "versions", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 548 + } + ], + "type": { + "name": "list[Version] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "Version", + "target": "1336" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 387, + "module": "_models", + "name": "pricing_infos", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 549 + } + ], + "type": { + "name": "Annotated[ list[ Annotated[ PayPerEventActorPricingInfo | PricePerDatasetItemActorPricingInfo | FlatPricePerMonthActorPricingInfo | FreeActorPricingInfo, Field(discriminator='pricing_model'), ] ] | None, Field(alias='pricingInfos'), ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "PayPerEventActorPricingInfo", + "target": "786" + }, + { + "type": "reference", + "name": "PricePerDatasetItemActorPricingInfo", + "target": "813" + } + ] + }, + { + "type": "reference", + "name": "FlatPricePerMonthActorPricingInfo", + "target": "570" + } + ] + }, + { + "type": "reference", + "name": "FreeActorPricingInfo", + "target": "575" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 388, + "module": "_models", + "name": "categories", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 562 + } + ], + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 389, + "module": "_models", + "name": "default_run_options", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 563 + } + ], + "type": { + "name": "Annotated[DefaultRunOptions | None, Field(alias='defaultRunOptions')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "DefaultRunOptions", + "target": "499" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 390, + "module": "_models", + "name": "actor_standby", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 564 + } + ], + "type": { + "name": "Annotated[ActorStandby | None, Field(alias='actorStandby')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorStandby", + "target": "255" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 391, + "module": "_models", + "name": "example_run_input", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 565 + } + ], + "type": { + "name": "Annotated[ExampleRunInput | None, Field(alias='exampleRunInput')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ExampleRunInput", + "target": "562" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 392, + "module": "_models", + "name": "is_deprecated", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 566 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='isDeprecated')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 390, + 388, + 389, + 380, + 391, + 392, + 382, + 378, + 379, + 387, + 385, + 384, + 383, + 381, + 386 + ], + "title": "Properties" + } + ], + "id": 377, + "module": "_models", + "name": "CreateActorRequest", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 536 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 394, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 571 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 395, + "module": "_models", + "name": "version_number", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 575 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='versionNumber', examples=['0.0'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 396, + "module": "_models", + "name": "source_type", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 576 + } + ], + "type": { + "name": "Annotated[VersionSourceType | None, Field(alias='sourceType')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "VersionSourceType", + "target": "1802" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 397, + "module": "_models", + "name": "env_vars", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 577 + } + ], + "type": { + "name": "Annotated[list[EnvVarRequest] | None, Field(alias='envVars')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "EnvVarRequest", + "target": "546" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 398, + "module": "_models", + "name": "apply_env_vars_to_build", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 578 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='applyEnvVarsToBuild', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 399, + "module": "_models", + "name": "build_tag", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 579 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='buildTag', examples=['latest'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 400, + "module": "_models", + "name": "source_files", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 580 + } + ], + "type": { + "name": "Annotated[ list[SourceCodeFile | SourceCodeFolder] | None, Field(alias='sourceFiles', title='VersionSourceFiles') ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "SourceCodeFile", + "target": "1158" + }, + { + "type": "reference", + "name": "SourceCodeFolder", + "target": "1163" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "URL of the Git repository when sourceType is GIT_REPO." + } + ] + }, + "flags": {}, + "groups": [], + "id": 401, + "module": "_models", + "name": "git_repo_url", + "parsedDocstring": { + "text": "URL of the Git repository when sourceType is GIT_REPO." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 583 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='gitRepoUrl')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "URL of the tarball when sourceType is TARBALL." + } + ] + }, + "flags": {}, + "groups": [], + "id": 402, + "module": "_models", + "name": "tarball_url", + "parsedDocstring": { + "text": "URL of the tarball when sourceType is TARBALL." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 587 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='tarballUrl')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "URL of the GitHub Gist when sourceType is GITHUB_GIST." + } + ] + }, + "flags": {}, + "groups": [], + "id": 403, + "module": "_models", + "name": "github_gist_url", + "parsedDocstring": { + "text": "URL of the GitHub Gist when sourceType is GITHUB_GIST." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 591 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='gitHubGistUrl')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 398, + 399, + 397, + 401, + 403, + 394, + 400, + 396, + 402, + 395 + ], + "title": "Properties" + } + ], + "id": 393, + "module": "_models", + "name": "CreateOrUpdateVersionRequest", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 570 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 405, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 599 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 406, + "module": "_models", + "name": "act_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 603 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 407, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 604 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['my-task'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 408, + "module": "_models", + "name": "options", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 605 + } + ], + "type": { + "name": "TaskOptions | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "TaskOptions", + "target": "1215" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 409, + "module": "_models", + "name": "input", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 606 + } + ], + "type": { + "name": "TaskInput | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "TaskInput", + "target": "1213" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 410, + "module": "_models", + "name": "title", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 607 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 411, + "module": "_models", + "name": "actor_standby", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 608 + } + ], + "type": { + "name": "Annotated[ActorStandby | None, Field(alias='actorStandby')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorStandby", + "target": "255" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 406, + 411, + 409, + 405, + 407, + 408, + 410 + ], + "title": "Properties" + } + ], + "id": 404, + "module": "_models", + "name": "CreateTaskRequest", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 598 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 413, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 613 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 414, + "module": "_models", + "name": "monthly_usage_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 617 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 415, + "module": "_models", + "name": "monthly_actor_compute_units", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 618 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 416, + "module": "_models", + "name": "monthly_external_data_transfer_gbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 619 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 417, + "module": "_models", + "name": "monthly_proxy_serps", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 622 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 418, + "module": "_models", + "name": "monthly_residential_proxy_gbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 623 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 419, + "module": "_models", + "name": "actor_memory_gbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 624 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 420, + "module": "_models", + "name": "actor_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 625 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 421, + "module": "_models", + "name": "actor_task_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 626 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 422, + "module": "_models", + "name": "active_actor_job_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 627 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 423, + "module": "_models", + "name": "team_account_seat_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 628 + } + ], + "type": { + "name": "int", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 422, + 420, + 419, + 421, + 413, + 415, + 416, + 417, + 418, + 414, + 423 + ], + "title": "Properties" + } + ], + "id": 412, + "module": "_models", + "name": "Current", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 612 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 425, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 633 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 426, + "module": "_models", + "name": "pricing_model", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 637 + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 425, + 426 + ], + "title": "Properties" + } + ], + "id": 424, + "module": "_models", + "name": "CurrentPricingInfo", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 632 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 428, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 642 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 429, + "module": "_models", + "name": "date", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 646 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 430, + "module": "_models", + "name": "service_usage", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 647 + } + ], + "type": { + "name": "dict", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "UsageItem", + "target": "1307" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 431, + "module": "_models", + "name": "total_usage_credits_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 648 + } + ], + "type": { + "name": "float", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 429, + 428, + 430, + 431 + ], + "title": "Properties" + } + ], + "id": 427, + "module": "_models", + "name": "DailyServiceUsages", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 641 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 433, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 653 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 434, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 657 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 435, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 658 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['d7b9MDYsbtX5L7XAj'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 436, + "module": "_models", + "name": "user_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 659 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 437, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 660 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 438, + "module": "_models", + "name": "modified_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 661 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 439, + "module": "_models", + "name": "accessed_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 662 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 440, + "module": "_models", + "name": "item_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 663 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 441, + "module": "_models", + "name": "clean_item_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 664 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 442, + "module": "_models", + "name": "act_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 665 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='actId')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 443, + "module": "_models", + "name": "act_run_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 666 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='actRunId')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 444, + "module": "_models", + "name": "fields", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 667 + } + ], + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Defines the schema of items in your dataset, the full specification can be found in [Apify docs](/platform/actors/development/actor-definition/dataset-schema)" + } + ] + }, + "flags": {}, + "groups": [], + "id": 445, + "module": "_models", + "name": "schema_", + "parsedDocstring": { + "text": "Defines the schema of items in your dataset, the full specification can be found in [Apify docs](/platform/actors/development/actor-definition/dataset-schema)" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 668 + } + ], + "type": { + "name": "Annotated[ dict[str, Any] | None, Field( alias='schema', examples=[ { 'actorSpecification': 1, 'title': 'My dataset', 'views': { 'overview': { 'title': 'Overview', 'transformation': {'fields': ['linkUrl']}, 'display': { 'component': 'table', 'properties': {'linkUrl': {'label': 'Link URL', 'format': 'link'}}, }, } }, } ], ), ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 446, + "module": "_models", + "name": "console_url", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 693 + } + ], + "type": { + "name": "AnyUrl", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A public link to access the dataset items directly." + } + ] + }, + "flags": {}, + "groups": [], + "id": 447, + "module": "_models", + "name": "items_public_url", + "parsedDocstring": { + "text": "A public link to access the dataset items directly." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 696 + } + ], + "type": { + "name": "Annotated[ AnyUrl | None, Field( alias='itemsPublicUrl', examples=['https://api.apify.com/v2/datasets/WkzbQMuFYuamGv3YF/items?signature=abc123'], ), ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AnyUrl" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the dataset." + } + ] + }, + "flags": {}, + "groups": [], + "id": 448, + "module": "_models", + "name": "url_signing_secret_key", + "parsedDocstring": { + "text": "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the dataset." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 706 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='urlSigningSecretKey')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 449, + "module": "_models", + "name": "general_access", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 710 + } + ], + "type": { + "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "GeneralAccess", + "target": "1797" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 450, + "module": "_models", + "name": "stats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 711 + } + ], + "type": { + "name": "DatasetStats | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "DatasetStats", + "target": "483" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 439, + 442, + 443, + 441, + 446, + 437, + 444, + 449, + 434, + 440, + 447, + 433, + 438, + 435, + 445, + 450, + 448, + 436 + ], + "title": "Properties" + } + ], + "id": 432, + "module": "_models", + "name": "Dataset", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 652 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 452, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 716 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Minimum value of the field. For numbers, this is calculated directly. For strings, this is the length of the shortest string. For arrays, this is the length of the shortest array. For objects, this is the number of keys in the smallest object." + } + ] + }, + "flags": {}, + "groups": [], + "id": 453, + "module": "_models", + "name": "min", + "parsedDocstring": { + "text": "Minimum value of the field. For numbers, this is calculated directly. For strings, this is the length of the shortest string. For arrays, this is the length of the shortest array. For objects, this is the number of keys in the smallest object." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 720 + } + ], + "type": { + "name": "float | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum value of the field. For numbers, this is calculated directly. For strings, this is the length of the longest string. For arrays, this is the length of the longest array. For objects, this is the number of keys in the largest object." + } + ] + }, + "flags": {}, + "groups": [], + "id": 454, + "module": "_models", + "name": "max", + "parsedDocstring": { + "text": "Maximum value of the field. For numbers, this is calculated directly. For strings, this is the length of the longest string. For arrays, this is the length of the longest array. For objects, this is the number of keys in the largest object." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 724 + } + ], + "type": { + "name": "float | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many items in the dataset have a null value for this field." + } + ] + }, + "flags": {}, + "groups": [], + "id": 455, + "module": "_models", + "name": "null_count", + "parsedDocstring": { + "text": "How many items in the dataset have a null value for this field." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 728 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='nullCount')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many items in the dataset are `undefined`, meaning that for example empty string is not considered empty." + } + ] + }, + "flags": {}, + "groups": [], + "id": 456, + "module": "_models", + "name": "empty_count", + "parsedDocstring": { + "text": "How many items in the dataset are `undefined`, meaning that for example empty string is not considered empty." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 732 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='emptyCount')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 456, + 454, + 453, + 452, + 455 + ], + "title": "Properties" + } + ], + "id": 451, + "module": "_models", + "name": "DatasetFieldStatistics", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 715 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 458, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 740 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 459, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 744 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 460, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 745 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 461, + "module": "_models", + "name": "user_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 746 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 462, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 747 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 463, + "module": "_models", + "name": "modified_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 748 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 464, + "module": "_models", + "name": "accessed_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 749 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 465, + "module": "_models", + "name": "item_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 750 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 466, + "module": "_models", + "name": "clean_item_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 751 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 467, + "module": "_models", + "name": "act_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 752 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='actId', examples=['zdc3Pyhyz3m8vjDeM'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 468, + "module": "_models", + "name": "act_run_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 753 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='actRunId', examples=['HG7ML7M8z78YcAPEB'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 464, + 467, + 468, + 466, + 462, + 459, + 465, + 458, + 463, + 460, + 461 + ], + "title": "Properties" + } + ], + "id": 457, + "module": "_models", + "name": "DatasetListItem", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 739 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 470, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 760 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 471, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 764 + } + ], + "type": { + "name": "Dataset", + "type": "reference", + "target": "432" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response containing dataset metadata." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 471, + 470 + ], + "title": "Properties" + } + ], + "id": 469, + "module": "_models", + "name": "DatasetResponse", + "parsedDocstring": { + "text": "Response containing dataset metadata." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 757 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 473, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 769 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the error." + } + ] + }, + "flags": {}, + "groups": [], + "id": 474, + "module": "_models", + "name": "type", + "parsedDocstring": { + "text": "The type of the error." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 773 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['schema-validation-error'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A human-readable message describing the error." + } + ] + }, + "flags": {}, + "groups": [], + "id": 475, + "module": "_models", + "name": "message", + "parsedDocstring": { + "text": "A human-readable message describing the error." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 777 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['Schema validation failed'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 476, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 781 + } + ], + "type": { + "name": "SchemaValidationErrorData | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "SchemaValidationErrorData", + "target": "1155" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 476, + 475, + 473, + 474 + ], + "title": "Properties" + } + ], + "id": 472, + "module": "_models", + "name": "DatasetSchemaValidationError", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 768 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 478, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 786 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "When you configure the dataset [fields schema](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation), we measure the statistics such as `min`, `max`, `nullCount` and `emptyCount` for each field. This property provides statistics for each field from dataset fields schema.

See dataset field statistics [documentation](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation#dataset-field-statistics) for more information." + } + ] + }, + "flags": {}, + "groups": [], + "id": 479, + "module": "_models", + "name": "field_statistics", + "parsedDocstring": { + "text": "When you configure the dataset [fields schema](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation), we measure the statistics such as `min`, `max`, `nullCount` and `emptyCount` for each field. This property provides statistics for each field from dataset fields schema.

See dataset field statistics [documentation](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation#dataset-field-statistics) for more information." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 790 + } + ], + "type": { + "name": "Annotated[dict[str, Any] | None, Field(alias='fieldStatistics')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 479, + 478 + ], + "title": "Properties" + } + ], + "id": 477, + "module": "_models", + "name": "DatasetStatistics", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 785 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 481, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 798 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 482, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 802 + } + ], + "type": { + "name": "DatasetStatistics", + "type": "reference", + "target": "477" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 482, + 481 + ], + "title": "Properties" + } + ], + "id": 480, + "module": "_models", + "name": "DatasetStatisticsResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 797 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 484, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 807 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 485, + "module": "_models", + "name": "read_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 811 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 486, + "module": "_models", + "name": "write_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 812 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 487, + "module": "_models", + "name": "storage_bytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 813 + } + ], + "type": { + "name": "int", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 484, + 485, + 487, + 486 + ], + "title": "Properties" + } + ], + "id": 483, + "module": "_models", + "name": "DatasetStats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 806 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 489, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 820 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the default dataset for this run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 490, + "module": "_models", + "name": "default", + "parsedDocstring": { + "text": "ID of the default dataset for this run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 824 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['wmKPijuyDnPZAPRMk'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Aliased dataset IDs for this run." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 490, + 489 + ], + "title": "Properties" + } + ], + "id": 488, + "module": "_models", + "name": "Datasets", + "parsedDocstring": { + "text": "Aliased dataset IDs for this run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 817 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 492, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 832 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The original object that was encoded." + } + ] + }, + "flags": {}, + "groups": [], + "id": 493, + "module": "_models", + "name": "decoded", + "parsedDocstring": { + "text": "The original object that was encoded." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 836 + } + ], + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 494, + "module": "_models", + "name": "encoded_by_user_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 840 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='encodedByUserId', examples=['wRwJZtadYvn4mBZmm'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 495, + "module": "_models", + "name": "is_verified_user", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 841 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 493, + 494, + 495, + 492 + ], + "title": "Properties" + } + ], + "id": 491, + "module": "_models", + "name": "DecodeAndVerifyData", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 831 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 497, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 846 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 498, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 850 + } + ], + "type": { + "name": "DecodeAndVerifyData", + "type": "reference", + "target": "491" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 498, + 497 + ], + "title": "Properties" + } + ], + "id": 496, + "module": "_models", + "name": "DecodeAndVerifyResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 845 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 500, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 855 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 501, + "module": "_models", + "name": "build", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 859 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['latest'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 502, + "module": "_models", + "name": "timeout_secs", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 860 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='timeoutSecs', examples=[3600])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 503, + "module": "_models", + "name": "memory_mbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 861 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='memoryMbytes', examples=[2048])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 504, + "module": "_models", + "name": "restart_on_error", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 862 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='restartOnError', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 505, + "module": "_models", + "name": "max_items", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 863 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='maxItems')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 506, + "module": "_models", + "name": "force_permission_level", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 864 + } + ], + "type": { + "name": "Annotated[ActorPermissionLevel | None, Field(alias='forcePermissionLevel')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorPermissionLevel", + "target": "1795" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 501, + 506, + 505, + 503, + 500, + 504, + 502 + ], + "title": "Properties" + } + ], + "id": 499, + "module": "_models", + "name": "DefaultRunOptions", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 854 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 508, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 871 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 509, + "module": "_models", + "name": "unique_key", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 875 + } + ], + "type": { + "name": "Annotated[ str | None, Field(alias='uniqueKey', examples=['GET|60d83e70|e3b0c442|https://apify.com']) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 510, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 881 + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Confirmation of a request that was successfully deleted, identified by its ID." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 510, + 508, + 509 + ], + "title": "Properties" + } + ], + "id": 507, + "module": "_models", + "name": "DeletedRequestById", + "parsedDocstring": { + "text": "Confirmation of a request that was successfully deleted, identified by its ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 868 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 512, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 891 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 513, + "module": "_models", + "name": "unique_key", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 895 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 514, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 899 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['sbJ7klsdf7ujN9l'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Confirmation of a request that was successfully deleted, identified by its unique key." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 514, + 512, + 513 + ], + "title": "Properties" + } + ], + "id": 511, + "module": "_models", + "name": "DeletedRequestByUniqueKey", + "parsedDocstring": { + "text": "Confirmation of a request that was successfully deleted, identified by its unique key." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 888 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 516, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 907 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 517, + "module": "_models", + "name": "is_enabled", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 911 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 518, + "module": "_models", + "name": "disabled_reason", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 912 + } + ], + "type": { + "name": "Annotated[ str | None, Field( alias='disabledReason', examples=[ 'The \"Selected public Actors for developers\" feature is not enabled for your account. Please upgrade your plan or contact support@apify.com' ], ), ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 519, + "module": "_models", + "name": "disabled_reason_type", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 921 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='disabledReasonType', examples=['DISABLED'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 520, + "module": "_models", + "name": "is_trial", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 922 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 521, + "module": "_models", + "name": "trial_expiration_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 923 + } + ], + "type": { + "name": "Annotated[ AwareDatetime | None, Field(alias='trialExpirationAt', examples=['2025-01-01T14:00:00.000Z']) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 518, + 519, + 517, + 520, + 516, + 521 + ], + "title": "Properties" + } + ], + "id": 515, + "module": "_models", + "name": "EffectivePlatformFeature", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 906 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 523, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 930 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 524, + "module": "_models", + "name": "actors", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 934 + } + ], + "type": { + "name": "EffectivePlatformFeature", + "type": "reference", + "target": "515" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 525, + "module": "_models", + "name": "storage", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 935 + } + ], + "type": { + "name": "EffectivePlatformFeature", + "type": "reference", + "target": "515" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 526, + "module": "_models", + "name": "scheduler", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 936 + } + ], + "type": { + "name": "EffectivePlatformFeature", + "type": "reference", + "target": "515" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 527, + "module": "_models", + "name": "proxy", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 937 + } + ], + "type": { + "name": "EffectivePlatformFeature", + "type": "reference", + "target": "515" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 528, + "module": "_models", + "name": "proxy_external_access", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 938 + } + ], + "type": { + "name": "EffectivePlatformFeature", + "type": "reference", + "target": "515" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 529, + "module": "_models", + "name": "proxy_residential", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 939 + } + ], + "type": { + "name": "EffectivePlatformFeature", + "type": "reference", + "target": "515" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 530, + "module": "_models", + "name": "proxy_serps", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 940 + } + ], + "type": { + "name": "EffectivePlatformFeature", + "type": "reference", + "target": "515" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 531, + "module": "_models", + "name": "webhooks", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 941 + } + ], + "type": { + "name": "EffectivePlatformFeature", + "type": "reference", + "target": "515" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 532, + "module": "_models", + "name": "actors_public_all", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 942 + } + ], + "type": { + "name": "EffectivePlatformFeature", + "type": "reference", + "target": "515" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 533, + "module": "_models", + "name": "actors_public_developer", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 943 + } + ], + "type": { + "name": "EffectivePlatformFeature", + "type": "reference", + "target": "515" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 524, + 532, + 533, + 523, + 527, + 528, + 529, + 530, + 526, + 525, + 531 + ], + "title": "Properties" + } + ], + "id": 522, + "module": "_models", + "name": "EffectivePlatformFeatures", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 929 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 535, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 948 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 536, + "module": "_models", + "name": "encoded", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 952 + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 536, + 535 + ], + "title": "Properties" + } + ], + "id": 534, + "module": "_models", + "name": "EncodeAndSignData", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 947 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "DecodeAndVerifyRequest", + "target": "537", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4143, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 948 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "inheritedFrom": { + "name": "EncodeAndSignData.model_config", + "target": 535, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4144, + "module": "_models", + "name": "encoded", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 952 + } + ], + "type": { + "name": "str", + "type": "reference" + }, + "inheritedFrom": { + "name": "EncodeAndSignData.encoded", + "target": 536, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4144, + 4143 + ], + "title": "Properties" + } + ], + "id": 537, + "module": "_models", + "name": "DecodeAndVerifyRequest", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 956 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "EncodeAndSignData", + "target": "534", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 539, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 962 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 540, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 966 + } + ], + "type": { + "name": "EncodeAndSignData", + "type": "reference", + "target": "534" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 540, + 539 + ], + "title": "Properties" + } + ], + "id": 538, + "module": "_models", + "name": "EncodeAndSignResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 961 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 542, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 971 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 543, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 975 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The environment variable value. This field is absent in responses when `isSecret` is `true`, as secret values are never returned by the API." + } + ] + }, + "flags": {}, + "groups": [], + "id": 544, + "module": "_models", + "name": "value", + "parsedDocstring": { + "text": "The environment variable value. This field is absent in responses when `isSecret` is `true`, as secret values are never returned by the API." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 976 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['my-value'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 545, + "module": "_models", + "name": "is_secret", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 980 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='isSecret', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 545, + 542, + 543, + 544 + ], + "title": "Properties" + } + ], + "id": 541, + "module": "_models", + "name": "EnvVar", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 970 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "EnvVarRequest", + "target": "546", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 547, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 985 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "EnvVar.model_config", + "target": 542, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4140, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 975 + } + ], + "type": { + "name": "str", + "type": "reference" + }, + "inheritedFrom": { + "name": "EnvVar.name", + "target": 543, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The environment variable value. This field is absent in responses when `isSecret` is `true`, as secret values are never returned by the API." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4141, + "module": "_models", + "name": "value", + "parsedDocstring": { + "text": "The environment variable value. This field is absent in responses when `isSecret` is `true`, as secret values are never returned by the API." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 976 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['my-value'])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "EnvVar.value", + "target": 544, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4142, + "module": "_models", + "name": "is_secret", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 980 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='isSecret', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "EnvVar.is_secret", + "target": 545, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4142, + 547, + 4140, + 4141 + ], + "title": "Properties" + } + ], + "id": 546, + "module": "_models", + "name": "EnvVarRequest", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 984 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "EnvVar", + "target": "541", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 549, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 993 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 550, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 997 + } + ], + "type": { + "name": "EnvVar", + "type": "reference", + "target": "541" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 550, + 549 + ], + "title": "Properties" + } + ], + "id": 548, + "module": "_models", + "name": "EnvVarResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 992 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 552, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1002 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 553, + "module": "_models", + "name": "type", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1006 + } + ], + "type": { + "name": "ErrorType | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ErrorType", + "target": "1796" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Human-readable error message describing what went wrong." + } + ] + }, + "flags": {}, + "groups": [], + "id": 554, + "module": "_models", + "name": "message", + "parsedDocstring": { + "text": "Human-readable error message describing what went wrong." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1007 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 554, + 552, + 553 + ], + "title": "Properties" + } + ], + "id": 551, + "module": "_models", + "name": "ErrorDetail", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1001 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "RunFailedErrorDetail", + "target": "989", + "type": "reference" + }, + { + "name": "RunTimeoutExceededErrorDetail", + "target": "1044", + "type": "reference" + }, + { + "name": "UnknownBuildTagErrorDetail", + "target": "1247", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 556, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1015 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 557, + "module": "_models", + "name": "error", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1019 + } + ], + "type": { + "name": "ErrorDetail", + "type": "reference", + "target": "551" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 557, + 556 + ], + "title": "Properties" + } + ], + "id": 555, + "module": "_models", + "name": "ErrorResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1014 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 559, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1024 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 560, + "module": "_models", + "name": "actor_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1028 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 561, + "module": "_models", + "name": "actor_run_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1029 + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 560, + 561, + 559 + ], + "title": "Properties" + } + ], + "id": 558, + "module": "_models", + "name": "EventData", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1023 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 563, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1034 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 564, + "module": "_models", + "name": "body", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1038 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['{ \"helloWorld\": 123 }'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 565, + "module": "_models", + "name": "content_type", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1039 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='contentType', examples=['application/json; charset=utf-8'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 564, + 565, + 563 + ], + "title": "Properties" + } + ], + "id": 562, + "module": "_models", + "name": "ExampleRunInput", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1033 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 567, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1044 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 568, + "module": "_models", + "name": "status", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1048 + } + ], + "type": { + "name": "WebhookDispatchStatus", + "type": "reference", + "target": "1803" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 569, + "module": "_models", + "name": "finished_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1049 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-13T08:36:13.202Z'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 569, + 567, + 568 + ], + "title": "Properties" + } + ], + "id": 566, + "module": "_models", + "name": "ExampleWebhookDispatch", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1043 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 571, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1056 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "CommonActorPricingInfo.model_config", + "target": 370, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 572, + "module": "_models", + "name": "pricing_model", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1060 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "FLAT_PRICE_PER_MONTH" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "For how long this Actor can be used for free in trial period" + } + ] + }, + "flags": {}, + "groups": [], + "id": 573, + "module": "_models", + "name": "trial_minutes", + "parsedDocstring": { + "text": "For how long this Actor can be used for free in trial period" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1061 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Monthly flat price in USD" + } + ] + }, + "flags": {}, + "groups": [], + "id": 574, + "module": "_models", + "name": "price_per_unit_usd", + "parsedDocstring": { + "text": "Monthly flat price in USD" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1065 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4116, + "module": "_models", + "name": "apify_margin_percentage", + "parsedDocstring": { + "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 518 + } + ], + "type": { + "name": "Annotated[float, Field(alias='apifyMarginPercentage')]", + "type": "reference" + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.apify_margin_percentage", + "target": 371, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "When this pricing info record has been created" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4117, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "When this pricing info record has been created" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 522 + } + ], + "type": { + "name": "Annotated[AwareDatetime, Field(alias='createdAt')]", + "type": "reference" + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.created_at", + "target": 372, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Since when is this pricing info record effective for a given Actor" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4118, + "module": "_models", + "name": "started_at", + "parsedDocstring": { + "text": "Since when is this pricing info record effective for a given Actor" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 526 + } + ], + "type": { + "name": "Annotated[AwareDatetime, Field(alias='startedAt')]", + "type": "reference" + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.started_at", + "target": 373, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4119, + "module": "_models", + "name": "notified_about_future_change_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 530 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutFutureChangeAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.notified_about_future_change_at", + "target": 374, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4120, + "module": "_models", + "name": "notified_about_change_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 531 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutChangeAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.notified_about_change_at", + "target": 375, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4121, + "module": "_models", + "name": "reason_for_change", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 532 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='reasonForChange')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.reason_for_change", + "target": 376, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4116, + 4117, + 571, + 4120, + 4119, + 574, + 572, + 4121, + 4118, + 573 + ], + "title": "Properties" + } + ], + "id": 570, + "module": "_models", + "name": "FlatPricePerMonthActorPricingInfo", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1055 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "CommonActorPricingInfo", + "target": "369", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 576, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1073 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "CommonActorPricingInfo.model_config", + "target": 370, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 577, + "module": "_models", + "name": "pricing_model", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1077 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "FREE" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4122, + "module": "_models", + "name": "apify_margin_percentage", + "parsedDocstring": { + "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 518 + } + ], + "type": { + "name": "Annotated[float, Field(alias='apifyMarginPercentage')]", + "type": "reference" + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.apify_margin_percentage", + "target": 371, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "When this pricing info record has been created" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4123, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "When this pricing info record has been created" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 522 + } + ], + "type": { + "name": "Annotated[AwareDatetime, Field(alias='createdAt')]", + "type": "reference" + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.created_at", + "target": 372, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Since when is this pricing info record effective for a given Actor" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4124, + "module": "_models", + "name": "started_at", + "parsedDocstring": { + "text": "Since when is this pricing info record effective for a given Actor" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 526 + } + ], + "type": { + "name": "Annotated[AwareDatetime, Field(alias='startedAt')]", + "type": "reference" + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.started_at", + "target": 373, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4125, + "module": "_models", + "name": "notified_about_future_change_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 530 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutFutureChangeAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.notified_about_future_change_at", + "target": 374, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4126, + "module": "_models", + "name": "notified_about_change_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 531 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutChangeAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.notified_about_change_at", + "target": 375, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4127, + "module": "_models", + "name": "reason_for_change", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 532 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='reasonForChange')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.reason_for_change", + "target": 376, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4122, + 4123, + 576, + 4126, + 4125, + 577, + 4127, + 4124 + ], + "title": "Properties" + } + ], + "id": 575, + "module": "_models", + "name": "FreeActorPricingInfo", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1072 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "CommonActorPricingInfo", + "target": "369", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 579, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1084 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 580, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1088 + } + ], + "type": { + "name": "LockedRequestQueueHead", + "type": "reference", + "target": "721" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response containing locked requests from the request queue head." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 580, + 579 + ], + "title": "Properties" + } + ], + "id": 578, + "module": "_models", + "name": "HeadAndLockResponse", + "parsedDocstring": { + "text": "Response containing locked requests from the request queue head." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1081 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 582, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1095 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 583, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1099 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 584, + "module": "_models", + "name": "unique_key", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1103 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 585, + "module": "_models", + "name": "url", + "parsedDocstring": { + "text": "The URL of the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1107 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 586, + "module": "_models", + "name": "method", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1111 + } + ], + "type": { + "name": "HttpMethod | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "HttpMethod", + "target": "1798" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of times this request has been retried." + } + ] + }, + "flags": {}, + "groups": [], + "id": 587, + "module": "_models", + "name": "retry_count", + "parsedDocstring": { + "text": "The number of times this request has been retried." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1112 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='retryCount', examples=[0])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request from the request queue head without lock information." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 583, + 586, + 582, + 587, + 584, + 585 + ], + "title": "Properties" + } + ], + "id": 581, + "module": "_models", + "name": "HeadRequest", + "parsedDocstring": { + "text": "A request from the request queue head without lock information." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1092 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 589, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1122 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 590, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1126 + } + ], + "type": { + "name": "RequestQueueHead", + "type": "reference", + "target": "913" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response containing requests from the request queue head without locking." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 590, + 589 + ], + "title": "Properties" + } + ], + "id": 588, + "module": "_models", + "name": "HeadResponse", + "parsedDocstring": { + "text": "Response containing requests from the request queue head without locking." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1119 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 592, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1131 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The position of the invalid item in the array." + } + ] + }, + "flags": {}, + "groups": [], + "id": 593, + "module": "_models", + "name": "item_position", + "parsedDocstring": { + "text": "The position of the invalid item in the array." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1135 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='itemPosition', examples=[2])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A complete list of AJV validation error objects for the invalid item." + } + ] + }, + "flags": {}, + "groups": [], + "id": 594, + "module": "_models", + "name": "validation_errors", + "parsedDocstring": { + "text": "A complete list of AJV validation error objects for the invalid item." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1139 + } + ], + "type": { + "name": "Annotated[list[ValidationError] | None, Field(alias='validationErrors')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "ValidationError", + "target": "1329" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 593, + 592, + 594 + ], + "title": "Properties" + } + ], + "id": 591, + "module": "_models", + "name": "InvalidItem", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1130 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 596, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1147 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 597, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1151 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 598, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1152 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['d7b9MDYsbtX5L7XAj'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 599, + "module": "_models", + "name": "user_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1153 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='userId', examples=['BPWDBd7Z9c746JAnF'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 600, + "module": "_models", + "name": "username", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1154 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['janedoe'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 601, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1155 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 602, + "module": "_models", + "name": "modified_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1156 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 603, + "module": "_models", + "name": "accessed_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1157 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 604, + "module": "_models", + "name": "act_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1158 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='actId', examples=[None])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 605, + "module": "_models", + "name": "act_run_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1159 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='actRunId', examples=[None])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 606, + "module": "_models", + "name": "console_url", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1160 + } + ], + "type": { + "name": "Annotated[ AnyUrl | None, Field(alias='consoleUrl', examples=['https://console.apify.com/storage/key-value-stores/27TmTznX9YPeAYhkC']), ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AnyUrl" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A public link to access keys of the key-value store directly." + } + ] + }, + "flags": {}, + "groups": [], + "id": 607, + "module": "_models", + "name": "keys_public_url", + "parsedDocstring": { + "text": "A public link to access keys of the key-value store directly." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1164 + } + ], + "type": { + "name": "Annotated[ AnyUrl | None, Field( alias='keysPublicUrl', examples=['https://api.apify.com/v2/key-value-stores/WkzbQMuFYuamGv3YF/keys?signature=abc123'], ), ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AnyUrl" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the key-value store." + } + ] + }, + "flags": {}, + "groups": [], + "id": 608, + "module": "_models", + "name": "url_signing_secret_key", + "parsedDocstring": { + "text": "A secret key for generating signed public URLs. It is only provided to clients with WRITE permission for the key-value store." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1174 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='urlSigningSecretKey')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 609, + "module": "_models", + "name": "general_access", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1178 + } + ], + "type": { + "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "GeneralAccess", + "target": "1797" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 610, + "module": "_models", + "name": "stats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1179 + } + ], + "type": { + "name": "KeyValueStoreStats | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "KeyValueStoreStats", + "target": "619" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 603, + 604, + 605, + 606, + 601, + 609, + 597, + 607, + 596, + 602, + 598, + 610, + 608, + 599, + 600 + ], + "title": "Properties" + } + ], + "id": 595, + "module": "_models", + "name": "KeyValueStore", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1146 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 612, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1184 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 613, + "module": "_models", + "name": "key", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1188 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 614, + "module": "_models", + "name": "size", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1189 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A public link to access this record directly." + } + ] + }, + "flags": {}, + "groups": [], + "id": 615, + "module": "_models", + "name": "record_public_url", + "parsedDocstring": { + "text": "A public link to access this record directly." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1190 + } + ], + "type": { + "name": "AnyUrl", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 613, + 612, + 615, + 614 + ], + "title": "Properties" + } + ], + "id": 611, + "module": "_models", + "name": "KeyValueStoreKey", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1183 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 617, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1206 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 618, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1210 + } + ], + "type": { + "name": "KeyValueStore", + "type": "reference", + "target": "595" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response containing key-value store data." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 618, + 617 + ], + "title": "Properties" + } + ], + "id": 616, + "module": "_models", + "name": "KeyValueStoreResponse", + "parsedDocstring": { + "text": "Response containing key-value store data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1203 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 620, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1215 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 621, + "module": "_models", + "name": "read_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1219 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 622, + "module": "_models", + "name": "write_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1220 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 623, + "module": "_models", + "name": "delete_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1221 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 624, + "module": "_models", + "name": "list_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1222 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 625, + "module": "_models", + "name": "s3_storage_bytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1223 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='s3StorageBytes', examples=[18])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 623, + 624, + 620, + 621, + 625, + 622 + ], + "title": "Properties" + } + ], + "id": 619, + "module": "_models", + "name": "KeyValueStoreStats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1214 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 627, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1230 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the default key-value store for this run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 628, + "module": "_models", + "name": "default", + "parsedDocstring": { + "text": "ID of the default key-value store for this run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1234 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['eJNzqsbPiopwJcgGQ'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Aliased key-value store IDs for this run." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 628, + 627 + ], + "title": "Properties" + } + ], + "id": 626, + "module": "_models", + "name": "KeyValueStores", + "parsedDocstring": { + "text": "Aliased key-value store IDs for this run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1227 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 630, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1242 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 631, + "module": "_models", + "name": "max_monthly_usage_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1246 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 632, + "module": "_models", + "name": "max_monthly_actor_compute_units", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1247 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 633, + "module": "_models", + "name": "max_monthly_external_data_transfer_gbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1248 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 634, + "module": "_models", + "name": "max_monthly_proxy_serps", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1251 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 635, + "module": "_models", + "name": "max_monthly_residential_proxy_gbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1252 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 636, + "module": "_models", + "name": "max_actor_memory_gbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1255 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 637, + "module": "_models", + "name": "max_actor_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1256 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 638, + "module": "_models", + "name": "max_actor_task_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1257 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 639, + "module": "_models", + "name": "max_concurrent_actor_jobs", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1258 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 640, + "module": "_models", + "name": "max_team_account_seat_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1259 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 641, + "module": "_models", + "name": "data_retention_days", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1260 + } + ], + "type": { + "name": "int", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 641, + 637, + 636, + 638, + 639, + 632, + 633, + 634, + 635, + 631, + 640, + 630 + ], + "title": "Properties" + } + ], + "id": 629, + "module": "_models", + "name": "Limits", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1241 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 643, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1265 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 644, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1269 + } + ], + "type": { + "name": "AccountLimits", + "type": "reference", + "target": "187" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 644, + 643 + ], + "title": "Properties" + } + ], + "id": 642, + "module": "_models", + "name": "LimitsResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1264 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 646, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1274 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 647, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1278 + } + ], + "type": { + "name": "ListOfStoreActors", + "type": "reference", + "target": "774" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 647, + 646 + ], + "title": "Properties" + } + ], + "id": 645, + "module": "_models", + "name": "ListOfActorsInStoreResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1273 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 649, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1283 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 650, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1287 + } + ], + "type": { + "name": "ListOfActors", + "type": "reference", + "target": "753" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 650, + 649 + ], + "title": "Properties" + } + ], + "id": 648, + "module": "_models", + "name": "ListOfActorsResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1282 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 652, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1292 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 653, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1296 + } + ], + "type": { + "name": "ListOfBuilds", + "type": "reference", + "target": "756" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 653, + 652 + ], + "title": "Properties" + } + ], + "id": 651, + "module": "_models", + "name": "ListOfBuildsResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1291 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 655, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1301 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 656, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1305 + } + ], + "type": { + "name": "ListOfDatasets", + "type": "reference", + "target": "759" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 656, + 655 + ], + "title": "Properties" + } + ], + "id": 654, + "module": "_models", + "name": "ListOfDatasetsResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1300 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 658, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1310 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 659, + "module": "_models", + "name": "total", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1314 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 660, + "module": "_models", + "name": "items", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1315 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "EnvVar", + "target": "541" + } + ], + "target": "2199" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 660, + 658, + 659 + ], + "title": "Properties" + } + ], + "id": 657, + "module": "_models", + "name": "ListOfEnvVars", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1309 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 662, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1320 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 663, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1324 + } + ], + "type": { + "name": "ListOfEnvVars", + "type": "reference", + "target": "657" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 663, + 662 + ], + "title": "Properties" + } + ], + "id": 661, + "module": "_models", + "name": "ListOfEnvVarsResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1319 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 665, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1329 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 666, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1333 + } + ], + "type": { + "name": "ListOfKeyValueStores", + "type": "reference", + "target": "762" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 666, + 665 + ], + "title": "Properties" + } + ], + "id": 664, + "module": "_models", + "name": "ListOfKeyValueStoresResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1328 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 668, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1338 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 669, + "module": "_models", + "name": "items", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1342 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "KeyValueStoreKey", + "target": "611" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 670, + "module": "_models", + "name": "count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1343 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 671, + "module": "_models", + "name": "limit", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1344 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 672, + "module": "_models", + "name": "exclusive_start_key", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1345 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='exclusiveStartKey', examples=['some-key'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 673, + "module": "_models", + "name": "is_truncated", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1346 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 674, + "module": "_models", + "name": "next_exclusive_start_key", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1347 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='nextExclusiveStartKey', examples=['third-key'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 670, + 672, + 673, + 669, + 671, + 668, + 674 + ], + "title": "Properties" + } + ], + "id": 667, + "module": "_models", + "name": "ListOfKeys", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1337 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 676, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1352 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 677, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1356 + } + ], + "type": { + "name": "ListOfKeys", + "type": "reference", + "target": "667" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 677, + 676 + ], + "title": "Properties" + } + ], + "id": 675, + "module": "_models", + "name": "ListOfKeysResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1351 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 679, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1363 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 680, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1367 + } + ], + "type": { + "name": "ListOfRequestQueues", + "type": "reference", + "target": "765" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response containing a list of request queues." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 680, + 679 + ], + "title": "Properties" + } + ], + "id": 678, + "module": "_models", + "name": "ListOfRequestQueuesResponse", + "parsedDocstring": { + "text": "Response containing a list of request queues." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1360 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 682, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1374 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The array of requests." + } + ] + }, + "flags": {}, + "groups": [], + "id": 683, + "module": "_models", + "name": "items", + "parsedDocstring": { + "text": "The array of requests." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1378 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Request", + "target": "876" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of requests returned in this response." + } + ] + }, + "flags": {}, + "groups": [], + "id": 684, + "module": "_models", + "name": "limit", + "parsedDocstring": { + "text": "The maximum number of requests returned in this response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1382 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the last request from the previous page, used for pagination." + } + ] + }, + "flags": {}, + "groups": [], + "id": 685, + "module": "_models", + "name": "exclusive_start_id", + "parsedDocstring": { + "text": "The ID of the last request from the previous page, used for pagination." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1386 + } + ], + "type": { + "name": "Annotated[ str | None, Field(alias='exclusiveStartId', deprecated=True, examples=['Ihnsp8YrvJ8102Kj']) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A cursor string used for current page of results." + } + ] + }, + "flags": {}, + "groups": [], + "id": 686, + "module": "_models", + "name": "cursor", + "parsedDocstring": { + "text": "A cursor string used for current page of results." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1392 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['eyJyZXF1ZXN0SWQiOiI0SVlLUWFXZ2FKUUlWNlMifQ'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A cursor string to be used to continue pagination." + } + ] + }, + "flags": {}, + "groups": [], + "id": 687, + "module": "_models", + "name": "next_cursor", + "parsedDocstring": { + "text": "A cursor string to be used to continue pagination." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1396 + } + ], + "type": { + "name": "Annotated[ str | None, Field(alias='nextCursor', examples=['eyJyZXF1ZXN0SWQiOiI5eFNNc1BrN1J6VUxTNXoifQ']) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A paginated list of requests from the request queue." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 686, + 685, + 683, + 684, + 682, + 687 + ], + "title": "Properties" + } + ], + "id": 681, + "module": "_models", + "name": "ListOfRequests", + "parsedDocstring": { + "text": "A paginated list of requests from the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1371 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 689, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1408 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 690, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1412 + } + ], + "type": { + "name": "ListOfRequests", + "type": "reference", + "target": "681" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response containing a list of requests from the request queue." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 690, + 689 + ], + "title": "Properties" + } + ], + "id": 688, + "module": "_models", + "name": "ListOfRequestsResponse", + "parsedDocstring": { + "text": "Response containing a list of requests from the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1405 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 692, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1417 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 693, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1421 + } + ], + "type": { + "name": "ListOfRuns", + "type": "reference", + "target": "768" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 693, + 692 + ], + "title": "Properties" + } + ], + "id": 691, + "module": "_models", + "name": "ListOfRunsResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1416 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 695, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1426 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 696, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1430 + } + ], + "type": { + "name": "ListOfSchedules", + "type": "reference", + "target": "771" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 696, + 695 + ], + "title": "Properties" + } + ], + "id": 694, + "module": "_models", + "name": "ListOfSchedulesResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1425 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 698, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1435 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 699, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1439 + } + ], + "type": { + "name": "ListOfTasks", + "type": "reference", + "target": "777" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 699, + 698 + ], + "title": "Properties" + } + ], + "id": 697, + "module": "_models", + "name": "ListOfTasksResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1434 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 701, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1444 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 702, + "module": "_models", + "name": "total", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1448 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 703, + "module": "_models", + "name": "items", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1449 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Version", + "target": "1336" + } + ], + "target": "2199" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 703, + 701, + 702 + ], + "title": "Properties" + } + ], + "id": 700, + "module": "_models", + "name": "ListOfVersions", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1443 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 705, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1454 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 706, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1458 + } + ], + "type": { + "name": "ListOfVersions", + "type": "reference", + "target": "700" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 706, + 705 + ], + "title": "Properties" + } + ], + "id": 704, + "module": "_models", + "name": "ListOfVersionsResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1453 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 708, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1463 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 709, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1467 + } + ], + "type": { + "name": "ListOfWebhookDispatches", + "type": "reference", + "target": "780" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 709, + 708 + ], + "title": "Properties" + } + ], + "id": 707, + "module": "_models", + "name": "ListOfWebhookDispatchesResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1462 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 711, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1472 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 712, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1476 + } + ], + "type": { + "name": "ListOfWebhooks", + "type": "reference", + "target": "783" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 712, + 711 + ], + "title": "Properties" + } + ], + "id": 710, + "module": "_models", + "name": "ListOfWebhooksResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1471 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 714, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1483 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 715, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1487 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 716, + "module": "_models", + "name": "unique_key", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1491 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 717, + "module": "_models", + "name": "url", + "parsedDocstring": { + "text": "The URL of the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1495 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 718, + "module": "_models", + "name": "method", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1499 + } + ], + "type": { + "name": "HttpMethod | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "HttpMethod", + "target": "1798" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of times this request has been retried." + } + ] + }, + "flags": {}, + "groups": [], + "id": 719, + "module": "_models", + "name": "retry_count", + "parsedDocstring": { + "text": "The number of times this request has been retried." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1500 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='retryCount', examples=[0])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timestamp when the lock on this request expires." + } + ] + }, + "flags": {}, + "groups": [], + "id": 720, + "module": "_models", + "name": "lock_expires_at", + "parsedDocstring": { + "text": "The timestamp when the lock on this request expires." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1504 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request from the request queue head that has been locked for processing." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 715, + 720, + 718, + 714, + 719, + 716, + 717 + ], + "title": "Properties" + } + ], + "id": 713, + "module": "_models", + "name": "LockedHeadRequest", + "parsedDocstring": { + "text": "A request from the request queue head that has been locked for processing." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1480 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 722, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1514 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of requests returned." + } + ] + }, + "flags": {}, + "groups": [], + "id": 723, + "module": "_models", + "name": "limit", + "parsedDocstring": { + "text": "The maximum number of requests returned." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1518 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 724, + "module": "_models", + "name": "queue_modified_at", + "parsedDocstring": { + "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1522 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the request queue contains requests locked by any client (either the one calling the endpoint or a different one)." + } + ] + }, + "flags": {}, + "groups": [], + "id": 725, + "module": "_models", + "name": "queue_has_locked_requests", + "parsedDocstring": { + "text": "Whether the request queue contains requests locked by any client (either the one calling the endpoint or a different one)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1526 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='queueHasLockedRequests', examples=[True])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The client key used for locking the requests." + } + ] + }, + "flags": {}, + "groups": [], + "id": 726, + "module": "_models", + "name": "client_key", + "parsedDocstring": { + "text": "The client key used for locking the requests." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1530 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='clientKey', examples=['client-one'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the request queue has been accessed by multiple different clients." + } + ] + }, + "flags": {}, + "groups": [], + "id": 727, + "module": "_models", + "name": "had_multiple_clients", + "parsedDocstring": { + "text": "Whether the request queue has been accessed by multiple different clients." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1534 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of seconds the locks will be held." + } + ] + }, + "flags": {}, + "groups": [], + "id": 728, + "module": "_models", + "name": "lock_secs", + "parsedDocstring": { + "text": "The number of seconds the locks will be held." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1538 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The array of locked requests from the request queue head." + } + ] + }, + "flags": {}, + "groups": [], + "id": 729, + "module": "_models", + "name": "items", + "parsedDocstring": { + "text": "The array of locked requests from the request queue head." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1542 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "LockedHeadRequest", + "target": "713" + } + ], + "target": "2199" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A batch of locked requests from the request queue head." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 726, + 727, + 729, + 723, + 728, + 722, + 725, + 724 + ], + "title": "Properties" + } + ], + "id": 721, + "module": "_models", + "name": "LockedRequestQueueHead", + "parsedDocstring": { + "text": "A batch of locked requests from the request queue head." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1511 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 731, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1552 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Time when the metamorph occurred." + } + ] + }, + "flags": {}, + "groups": [], + "id": 732, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "Time when the metamorph occurred." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1556 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the Actor that the run was metamorphed to." + } + ] + }, + "flags": {}, + "groups": [], + "id": 733, + "module": "_models", + "name": "actor_id", + "parsedDocstring": { + "text": "ID of the Actor that the run was metamorphed to." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1560 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the build used for the metamorphed Actor." + } + ] + }, + "flags": {}, + "groups": [], + "id": 734, + "module": "_models", + "name": "build_id", + "parsedDocstring": { + "text": "ID of the build used for the metamorphed Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1564 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Key of the input record in the key-value store." + } + ] + }, + "flags": {}, + "groups": [], + "id": 735, + "module": "_models", + "name": "input_key", + "parsedDocstring": { + "text": "Key of the input record in the key-value store." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1568 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='inputKey', examples=['INPUT-METAMORPH-1'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Information about a metamorph event that occurred during the run." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 733, + 734, + 732, + 735, + 731 + ], + "title": "Properties" + } + ], + "id": 730, + "module": "_models", + "name": "Metamorph", + "parsedDocstring": { + "text": "Information about a metamorph event that occurred during the run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1549 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 737, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1576 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 738, + "module": "_models", + "name": "usage_cycle", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1580 + } + ], + "type": { + "name": "UsageCycle", + "type": "reference", + "target": "1303" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 739, + "module": "_models", + "name": "monthly_service_usage", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1581 + } + ], + "type": { + "name": "dict", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "UsageItem", + "target": "1307" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 740, + "module": "_models", + "name": "daily_service_usages", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1582 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "DailyServiceUsages", + "target": "427" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 741, + "module": "_models", + "name": "total_usage_credits_usd_before_volume_discount", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1583 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 742, + "module": "_models", + "name": "total_usage_credits_usd_after_volume_discount", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1586 + } + ], + "type": { + "name": "float", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 740, + 737, + 739, + 742, + 741, + 738 + ], + "title": "Properties" + } + ], + "id": 736, + "module": "_models", + "name": "MonthlyUsage", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1575 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 744, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1593 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 745, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1597 + } + ], + "type": { + "name": "MonthlyUsage", + "type": "reference", + "target": "736" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 745, + 744 + ], + "title": "Properties" + } + ], + "id": 743, + "module": "_models", + "name": "MonthlyUsageResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1592 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 747, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1604 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available across all pages." + } + ] + }, + "flags": {}, + "groups": [], + "id": 748, + "module": "_models", + "name": "total", + "parsedDocstring": { + "text": "The total number of items available across all pages." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1608 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The starting position for this page of results." + } + ] + }, + "flags": {}, + "groups": [], + "id": 749, + "module": "_models", + "name": "offset", + "parsedDocstring": { + "text": "The starting position for this page of results." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1612 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items returned per page." + } + ] + }, + "flags": {}, + "groups": [], + "id": 750, + "module": "_models", + "name": "limit", + "parsedDocstring": { + "text": "The maximum number of items returned per page." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1616 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the results are sorted in descending order." + } + ] + }, + "flags": {}, + "groups": [], + "id": 751, + "module": "_models", + "name": "desc", + "parsedDocstring": { + "text": "Whether the results are sorted in descending order." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1620 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items returned in this response." + } + ] + }, + "flags": {}, + "groups": [], + "id": 752, + "module": "_models", + "name": "count", + "parsedDocstring": { + "text": "The number of items returned in this response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1624 + } + ], + "type": { + "name": "int", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Common pagination fields for list responses." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 752, + 751, + 750, + 747, + 749, + 748 + ], + "title": "Properties" + } + ], + "id": 746, + "module": "_models", + "name": "PaginationResponse", + "parsedDocstring": { + "text": "Common pagination fields for list responses." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1601 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "ListOfActors", + "target": "753", + "type": "reference" + }, + { + "name": "ListOfBuilds", + "target": "756", + "type": "reference" + }, + { + "name": "ListOfDatasets", + "target": "759", + "type": "reference" + }, + { + "name": "ListOfKeyValueStores", + "target": "762", + "type": "reference" + }, + { + "name": "ListOfRequestQueues", + "target": "765", + "type": "reference" + }, + { + "name": "ListOfRuns", + "target": "768", + "type": "reference" + }, + { + "name": "ListOfSchedules", + "target": "771", + "type": "reference" + }, + { + "name": "ListOfStoreActors", + "target": "774", + "type": "reference" + }, + { + "name": "ListOfTasks", + "target": "777", + "type": "reference" + }, + { + "name": "ListOfWebhookDispatches", + "target": "780", + "type": "reference" + }, + { + "name": "ListOfWebhooks", + "target": "783", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 754, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1632 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "PaginationResponse.model_config", + "target": 747, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 755, + "module": "_models", + "name": "items", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1636 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorShort", + "target": "246" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available across all pages." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4061, + "module": "_models", + "name": "total", + "parsedDocstring": { + "text": "The total number of items available across all pages." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1608 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.total", + "target": 748, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The starting position for this page of results." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4062, + "module": "_models", + "name": "offset", + "parsedDocstring": { + "text": "The starting position for this page of results." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1612 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[0], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.offset", + "target": 749, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items returned per page." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4063, + "module": "_models", + "name": "limit", + "parsedDocstring": { + "text": "The maximum number of items returned per page." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1616 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1000], ge=1)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.limit", + "target": 750, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the results are sorted in descending order." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4064, + "module": "_models", + "name": "desc", + "parsedDocstring": { + "text": "Whether the results are sorted in descending order." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1620 + } + ], + "type": { + "name": "Annotated[bool, Field(examples=[False])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.desc", + "target": 751, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items returned in this response." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4065, + "module": "_models", + "name": "count", + "parsedDocstring": { + "text": "The number of items returned in this response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1624 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.count", + "target": 752, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4065, + 4064, + 755, + 4063, + 754, + 4062, + 4061 + ], + "title": "Properties" + } + ], + "id": 753, + "module": "_models", + "name": "ListOfActors", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1631 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "PaginationResponse", + "target": "746", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 757, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1641 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "PaginationResponse.model_config", + "target": 747, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 758, + "module": "_models", + "name": "items", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1645 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "BuildShort", + "target": "333" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available across all pages." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4066, + "module": "_models", + "name": "total", + "parsedDocstring": { + "text": "The total number of items available across all pages." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1608 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.total", + "target": 748, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The starting position for this page of results." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4067, + "module": "_models", + "name": "offset", + "parsedDocstring": { + "text": "The starting position for this page of results." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1612 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[0], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.offset", + "target": 749, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items returned per page." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4068, + "module": "_models", + "name": "limit", + "parsedDocstring": { + "text": "The maximum number of items returned per page." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1616 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1000], ge=1)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.limit", + "target": 750, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the results are sorted in descending order." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4069, + "module": "_models", + "name": "desc", + "parsedDocstring": { + "text": "Whether the results are sorted in descending order." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1620 + } + ], + "type": { + "name": "Annotated[bool, Field(examples=[False])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.desc", + "target": 751, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items returned in this response." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4070, + "module": "_models", + "name": "count", + "parsedDocstring": { + "text": "The number of items returned in this response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1624 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.count", + "target": 752, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4070, + 4069, + 758, + 4068, + 757, + 4067, + 4066 + ], + "title": "Properties" + } + ], + "id": 756, + "module": "_models", + "name": "ListOfBuilds", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1640 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "PaginationResponse", + "target": "746", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 760, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1650 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "PaginationResponse.model_config", + "target": 747, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 761, + "module": "_models", + "name": "items", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1654 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "DatasetListItem", + "target": "457" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available across all pages." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4071, + "module": "_models", + "name": "total", + "parsedDocstring": { + "text": "The total number of items available across all pages." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1608 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.total", + "target": 748, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The starting position for this page of results." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4072, + "module": "_models", + "name": "offset", + "parsedDocstring": { + "text": "The starting position for this page of results." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1612 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[0], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.offset", + "target": 749, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items returned per page." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4073, + "module": "_models", + "name": "limit", + "parsedDocstring": { + "text": "The maximum number of items returned per page." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1616 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1000], ge=1)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.limit", + "target": 750, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the results are sorted in descending order." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4074, + "module": "_models", + "name": "desc", + "parsedDocstring": { + "text": "Whether the results are sorted in descending order." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1620 + } + ], + "type": { + "name": "Annotated[bool, Field(examples=[False])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.desc", + "target": 751, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items returned in this response." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4075, + "module": "_models", + "name": "count", + "parsedDocstring": { + "text": "The number of items returned in this response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1624 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.count", + "target": 752, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4075, + 4074, + 761, + 4073, + 760, + 4072, + 4071 + ], + "title": "Properties" + } + ], + "id": 759, + "module": "_models", + "name": "ListOfDatasets", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1649 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "PaginationResponse", + "target": "746", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 763, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1659 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "PaginationResponse.model_config", + "target": 747, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 764, + "module": "_models", + "name": "items", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1663 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "KeyValueStore", + "target": "595" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available across all pages." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4076, + "module": "_models", + "name": "total", + "parsedDocstring": { + "text": "The total number of items available across all pages." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1608 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.total", + "target": 748, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The starting position for this page of results." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4077, + "module": "_models", + "name": "offset", + "parsedDocstring": { + "text": "The starting position for this page of results." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1612 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[0], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.offset", + "target": 749, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items returned per page." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4078, + "module": "_models", + "name": "limit", + "parsedDocstring": { + "text": "The maximum number of items returned per page." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1616 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1000], ge=1)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.limit", + "target": 750, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the results are sorted in descending order." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4079, + "module": "_models", + "name": "desc", + "parsedDocstring": { + "text": "Whether the results are sorted in descending order." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1620 + } + ], + "type": { + "name": "Annotated[bool, Field(examples=[False])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.desc", + "target": 751, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items returned in this response." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4080, + "module": "_models", + "name": "count", + "parsedDocstring": { + "text": "The number of items returned in this response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1624 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.count", + "target": 752, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4080, + 4079, + 764, + 4078, + 763, + 4077, + 4076 + ], + "title": "Properties" + } + ], + "id": 762, + "module": "_models", + "name": "ListOfKeyValueStores", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1658 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "PaginationResponse", + "target": "746", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 766, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1670 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "PaginationResponse.model_config", + "target": 747, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The array of request queues." + } + ] + }, + "flags": {}, + "groups": [], + "id": 767, + "module": "_models", + "name": "items", + "parsedDocstring": { + "text": "The array of request queues." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1674 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "RequestQueueShort", + "target": "922" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available across all pages." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4081, + "module": "_models", + "name": "total", + "parsedDocstring": { + "text": "The total number of items available across all pages." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1608 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.total", + "target": 748, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The starting position for this page of results." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4082, + "module": "_models", + "name": "offset", + "parsedDocstring": { + "text": "The starting position for this page of results." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1612 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[0], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.offset", + "target": 749, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items returned per page." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4083, + "module": "_models", + "name": "limit", + "parsedDocstring": { + "text": "The maximum number of items returned per page." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1616 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1000], ge=1)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.limit", + "target": 750, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the results are sorted in descending order." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4084, + "module": "_models", + "name": "desc", + "parsedDocstring": { + "text": "Whether the results are sorted in descending order." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1620 + } + ], + "type": { + "name": "Annotated[bool, Field(examples=[False])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.desc", + "target": 751, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items returned in this response." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4085, + "module": "_models", + "name": "count", + "parsedDocstring": { + "text": "The number of items returned in this response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1624 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.count", + "target": 752, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A paginated list of request queues." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4085, + 4084, + 767, + 4083, + 766, + 4082, + 4081 + ], + "title": "Properties" + } + ], + "id": 765, + "module": "_models", + "name": "ListOfRequestQueues", + "parsedDocstring": { + "text": "A paginated list of request queues." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1667 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "PaginationResponse", + "target": "746", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 769, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1682 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "PaginationResponse.model_config", + "target": 747, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 770, + "module": "_models", + "name": "items", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1686 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "RunShort", + "target": "1010" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available across all pages." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4086, + "module": "_models", + "name": "total", + "parsedDocstring": { + "text": "The total number of items available across all pages." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1608 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.total", + "target": 748, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The starting position for this page of results." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4087, + "module": "_models", + "name": "offset", + "parsedDocstring": { + "text": "The starting position for this page of results." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1612 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[0], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.offset", + "target": 749, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items returned per page." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4088, + "module": "_models", + "name": "limit", + "parsedDocstring": { + "text": "The maximum number of items returned per page." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1616 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1000], ge=1)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.limit", + "target": 750, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the results are sorted in descending order." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4089, + "module": "_models", + "name": "desc", + "parsedDocstring": { + "text": "Whether the results are sorted in descending order." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1620 + } + ], + "type": { + "name": "Annotated[bool, Field(examples=[False])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.desc", + "target": 751, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items returned in this response." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4090, + "module": "_models", + "name": "count", + "parsedDocstring": { + "text": "The number of items returned in this response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1624 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.count", + "target": 752, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4090, + 4089, + 770, + 4088, + 769, + 4087, + 4086 + ], + "title": "Properties" + } + ], + "id": 768, + "module": "_models", + "name": "ListOfRuns", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1681 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "PaginationResponse", + "target": "746", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 772, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1691 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "PaginationResponse.model_config", + "target": 747, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 773, + "module": "_models", + "name": "items", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1695 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ScheduleShort", + "target": "1152" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available across all pages." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4091, + "module": "_models", + "name": "total", + "parsedDocstring": { + "text": "The total number of items available across all pages." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1608 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.total", + "target": 748, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The starting position for this page of results." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4092, + "module": "_models", + "name": "offset", + "parsedDocstring": { + "text": "The starting position for this page of results." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1612 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[0], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.offset", + "target": 749, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items returned per page." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4093, + "module": "_models", + "name": "limit", + "parsedDocstring": { + "text": "The maximum number of items returned per page." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1616 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1000], ge=1)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.limit", + "target": 750, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the results are sorted in descending order." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4094, + "module": "_models", + "name": "desc", + "parsedDocstring": { + "text": "Whether the results are sorted in descending order." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1620 + } + ], + "type": { + "name": "Annotated[bool, Field(examples=[False])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.desc", + "target": 751, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items returned in this response." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4095, + "module": "_models", + "name": "count", + "parsedDocstring": { + "text": "The number of items returned in this response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1624 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.count", + "target": 752, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4095, + 4094, + 773, + 4093, + 772, + 4092, + 4091 + ], + "title": "Properties" + } + ], + "id": 771, + "module": "_models", + "name": "ListOfSchedules", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1690 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "PaginationResponse", + "target": "746", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 775, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1700 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "PaginationResponse.model_config", + "target": 747, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 776, + "module": "_models", + "name": "items", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1704 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "StoreListActor", + "target": "1175" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available across all pages." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4096, + "module": "_models", + "name": "total", + "parsedDocstring": { + "text": "The total number of items available across all pages." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1608 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.total", + "target": 748, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The starting position for this page of results." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4097, + "module": "_models", + "name": "offset", + "parsedDocstring": { + "text": "The starting position for this page of results." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1612 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[0], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.offset", + "target": 749, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items returned per page." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4098, + "module": "_models", + "name": "limit", + "parsedDocstring": { + "text": "The maximum number of items returned per page." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1616 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1000], ge=1)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.limit", + "target": 750, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the results are sorted in descending order." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4099, + "module": "_models", + "name": "desc", + "parsedDocstring": { + "text": "Whether the results are sorted in descending order." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1620 + } + ], + "type": { + "name": "Annotated[bool, Field(examples=[False])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.desc", + "target": 751, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items returned in this response." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4100, + "module": "_models", + "name": "count", + "parsedDocstring": { + "text": "The number of items returned in this response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1624 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.count", + "target": 752, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4100, + 4099, + 776, + 4098, + 775, + 4097, + 4096 + ], + "title": "Properties" + } + ], + "id": 774, + "module": "_models", + "name": "ListOfStoreActors", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1699 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "PaginationResponse", + "target": "746", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 778, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1709 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "PaginationResponse.model_config", + "target": 747, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 779, + "module": "_models", + "name": "items", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1713 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "TaskShort", + "target": "1226" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available across all pages." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4101, + "module": "_models", + "name": "total", + "parsedDocstring": { + "text": "The total number of items available across all pages." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1608 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.total", + "target": 748, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The starting position for this page of results." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4102, + "module": "_models", + "name": "offset", + "parsedDocstring": { + "text": "The starting position for this page of results." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1612 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[0], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.offset", + "target": 749, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items returned per page." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4103, + "module": "_models", + "name": "limit", + "parsedDocstring": { + "text": "The maximum number of items returned per page." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1616 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1000], ge=1)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.limit", + "target": 750, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the results are sorted in descending order." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4104, + "module": "_models", + "name": "desc", + "parsedDocstring": { + "text": "Whether the results are sorted in descending order." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1620 + } + ], + "type": { + "name": "Annotated[bool, Field(examples=[False])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.desc", + "target": 751, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items returned in this response." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4105, + "module": "_models", + "name": "count", + "parsedDocstring": { + "text": "The number of items returned in this response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1624 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.count", + "target": 752, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4105, + 4104, + 779, + 4103, + 778, + 4102, + 4101 + ], + "title": "Properties" + } + ], + "id": 777, + "module": "_models", + "name": "ListOfTasks", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1708 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "PaginationResponse", + "target": "746", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 781, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1718 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "PaginationResponse.model_config", + "target": 747, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 782, + "module": "_models", + "name": "items", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1722 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookDispatch", + "target": "1386" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available across all pages." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4106, + "module": "_models", + "name": "total", + "parsedDocstring": { + "text": "The total number of items available across all pages." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1608 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.total", + "target": 748, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The starting position for this page of results." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4107, + "module": "_models", + "name": "offset", + "parsedDocstring": { + "text": "The starting position for this page of results." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1612 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[0], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.offset", + "target": 749, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items returned per page." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4108, + "module": "_models", + "name": "limit", + "parsedDocstring": { + "text": "The maximum number of items returned per page." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1616 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1000], ge=1)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.limit", + "target": 750, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the results are sorted in descending order." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4109, + "module": "_models", + "name": "desc", + "parsedDocstring": { + "text": "Whether the results are sorted in descending order." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1620 + } + ], + "type": { + "name": "Annotated[bool, Field(examples=[False])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.desc", + "target": 751, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items returned in this response." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4110, + "module": "_models", + "name": "count", + "parsedDocstring": { + "text": "The number of items returned in this response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1624 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.count", + "target": 752, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4110, + 4109, + 782, + 4108, + 781, + 4107, + 4106 + ], + "title": "Properties" + } + ], + "id": 780, + "module": "_models", + "name": "ListOfWebhookDispatches", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1717 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "PaginationResponse", + "target": "746", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 784, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1727 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "PaginationResponse.model_config", + "target": 747, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 785, + "module": "_models", + "name": "items", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1731 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookShort", + "target": "1406" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available across all pages." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4111, + "module": "_models", + "name": "total", + "parsedDocstring": { + "text": "The total number of items available across all pages." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1608 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.total", + "target": 748, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The starting position for this page of results." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4112, + "module": "_models", + "name": "offset", + "parsedDocstring": { + "text": "The starting position for this page of results." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1612 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[0], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.offset", + "target": 749, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items returned per page." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4113, + "module": "_models", + "name": "limit", + "parsedDocstring": { + "text": "The maximum number of items returned per page." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1616 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1000], ge=1)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.limit", + "target": 750, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the results are sorted in descending order." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4114, + "module": "_models", + "name": "desc", + "parsedDocstring": { + "text": "Whether the results are sorted in descending order." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1620 + } + ], + "type": { + "name": "Annotated[bool, Field(examples=[False])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.desc", + "target": 751, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items returned in this response." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4115, + "module": "_models", + "name": "count", + "parsedDocstring": { + "text": "The number of items returned in this response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1624 + } + ], + "type": { + "name": "Annotated[int, Field(examples=[1], ge=0)]", + "type": "reference" + }, + "inheritedFrom": { + "name": "PaginationResponse.count", + "target": 752, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4115, + 4114, + 785, + 4113, + 784, + 4112, + 4111 + ], + "title": "Properties" + } + ], + "id": 783, + "module": "_models", + "name": "ListOfWebhooks", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1726 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "PaginationResponse", + "target": "746", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 787, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1736 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "CommonActorPricingInfo.model_config", + "target": 370, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 788, + "module": "_models", + "name": "pricing_model", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1740 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "PAY_PER_EVENT" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 789, + "module": "_models", + "name": "pricing_per_event", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1741 + } + ], + "type": { + "name": "PricingPerEvent", + "type": "reference", + "target": "825" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 790, + "module": "_models", + "name": "minimal_max_total_charge_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1742 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='minimalMaxTotalChargeUsd')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4128, + "module": "_models", + "name": "apify_margin_percentage", + "parsedDocstring": { + "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 518 + } + ], + "type": { + "name": "Annotated[float, Field(alias='apifyMarginPercentage')]", + "type": "reference" + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.apify_margin_percentage", + "target": 371, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "When this pricing info record has been created" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4129, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "When this pricing info record has been created" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 522 + } + ], + "type": { + "name": "Annotated[AwareDatetime, Field(alias='createdAt')]", + "type": "reference" + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.created_at", + "target": 372, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Since when is this pricing info record effective for a given Actor" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4130, + "module": "_models", + "name": "started_at", + "parsedDocstring": { + "text": "Since when is this pricing info record effective for a given Actor" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 526 + } + ], + "type": { + "name": "Annotated[AwareDatetime, Field(alias='startedAt')]", + "type": "reference" + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.started_at", + "target": 373, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4131, + "module": "_models", + "name": "notified_about_future_change_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 530 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutFutureChangeAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.notified_about_future_change_at", + "target": 374, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4132, + "module": "_models", + "name": "notified_about_change_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 531 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutChangeAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.notified_about_change_at", + "target": 375, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4133, + "module": "_models", + "name": "reason_for_change", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 532 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='reasonForChange')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.reason_for_change", + "target": 376, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4128, + 4129, + 790, + 787, + 4132, + 4131, + 788, + 789, + 4133, + 4130 + ], + "title": "Properties" + } + ], + "id": 786, + "module": "_models", + "name": "PayPerEventActorPricingInfo", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1735 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "CommonActorPricingInfo", + "target": "369", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 792, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1747 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 793, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1751 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 794, + "module": "_models", + "name": "description", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1752 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 795, + "module": "_models", + "name": "is_enabled", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1753 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 796, + "module": "_models", + "name": "monthly_base_price_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1754 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 797, + "module": "_models", + "name": "monthly_usage_credits_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1755 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 798, + "module": "_models", + "name": "usage_discount_percent", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1756 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='usageDiscountPercent', examples=[0])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 799, + "module": "_models", + "name": "enabled_platform_features", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1757 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 800, + "module": "_models", + "name": "max_monthly_usage_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1763 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 801, + "module": "_models", + "name": "max_actor_memory_gbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1764 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 802, + "module": "_models", + "name": "max_monthly_actor_compute_units", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1765 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 803, + "module": "_models", + "name": "max_monthly_residential_proxy_gbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1766 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 804, + "module": "_models", + "name": "max_monthly_proxy_serps", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1769 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 805, + "module": "_models", + "name": "max_monthly_external_data_transfer_gbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1770 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 806, + "module": "_models", + "name": "max_actor_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1773 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 807, + "module": "_models", + "name": "max_actor_task_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1774 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 808, + "module": "_models", + "name": "data_retention_days", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1775 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of available proxies in this group." + } + ] + }, + "flags": {}, + "groups": [], + "id": 809, + "module": "_models", + "name": "available_proxy_groups", + "parsedDocstring": { + "text": "The number of available proxies in this group." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1776 + } + ], + "type": { + "name": "dict", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 810, + "module": "_models", + "name": "team_account_seat_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1780 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 811, + "module": "_models", + "name": "support_level", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1781 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 812, + "module": "_models", + "name": "available_add_ons", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1782 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 812, + 809, + 808, + 794, + 799, + 793, + 795, + 806, + 801, + 807, + 802, + 805, + 804, + 803, + 800, + 792, + 796, + 797, + 811, + 810, + 798 + ], + "title": "Properties" + } + ], + "id": 791, + "module": "_models", + "name": "Plan", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1746 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 814, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1787 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "CommonActorPricingInfo.model_config", + "target": 370, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 815, + "module": "_models", + "name": "pricing_model", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1791 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "PRICE_PER_DATASET_ITEM" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the unit that is being charged" + } + ] + }, + "flags": {}, + "groups": [], + "id": 816, + "module": "_models", + "name": "unit_name", + "parsedDocstring": { + "text": "Name of the unit that is being charged" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1792 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 817, + "module": "_models", + "name": "price_per_unit_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1796 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4134, + "module": "_models", + "name": "apify_margin_percentage", + "parsedDocstring": { + "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 518 + } + ], + "type": { + "name": "Annotated[float, Field(alias='apifyMarginPercentage')]", + "type": "reference" + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.apify_margin_percentage", + "target": 371, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "When this pricing info record has been created" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4135, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "When this pricing info record has been created" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 522 + } + ], + "type": { + "name": "Annotated[AwareDatetime, Field(alias='createdAt')]", + "type": "reference" + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.created_at", + "target": 372, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Since when is this pricing info record effective for a given Actor" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4136, + "module": "_models", + "name": "started_at", + "parsedDocstring": { + "text": "Since when is this pricing info record effective for a given Actor" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 526 + } + ], + "type": { + "name": "Annotated[AwareDatetime, Field(alias='startedAt')]", + "type": "reference" + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.started_at", + "target": 373, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4137, + "module": "_models", + "name": "notified_about_future_change_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 530 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutFutureChangeAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.notified_about_future_change_at", + "target": 374, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4138, + "module": "_models", + "name": "notified_about_change_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 531 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='notifiedAboutChangeAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.notified_about_change_at", + "target": 375, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4139, + "module": "_models", + "name": "reason_for_change", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 532 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='reasonForChange')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "CommonActorPricingInfo.reason_for_change", + "target": 376, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4134, + 4135, + 814, + 4138, + 4137, + 817, + 815, + 4139, + 4136, + 816 + ], + "title": "Properties" + } + ], + "id": 813, + "module": "_models", + "name": "PricePerDatasetItemActorPricingInfo", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1786 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "CommonActorPricingInfo", + "target": "369", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 819, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1801 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 820, + "module": "_models", + "name": "quantity_above", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1805 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 821, + "module": "_models", + "name": "discount_percent", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1806 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 822, + "module": "_models", + "name": "tier_quantity", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1807 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 823, + "module": "_models", + "name": "unit_price_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1808 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 824, + "module": "_models", + "name": "price_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1809 + } + ], + "type": { + "name": "float", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 821, + 819, + 824, + 820, + 822, + 823 + ], + "title": "Properties" + } + ], + "id": 818, + "module": "_models", + "name": "PriceTiers", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1800 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 826, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1814 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 827, + "module": "_models", + "name": "actor_charge_events", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1818 + } + ], + "type": { + "name": "Annotated[dict[str, ActorChargeEvent] | None, Field(alias='actorChargeEvents')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "ActorChargeEvent", + "target": "215" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 827, + 826 + ], + "title": "Properties" + } + ], + "id": 825, + "module": "_models", + "name": "PricingPerEvent", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1813 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 829, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1823 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 830, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1827 + } + ], + "type": { + "name": "UserPrivateInfo", + "type": "reference", + "target": "1314" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 830, + 829 + ], + "title": "Properties" + } + ], + "id": 828, + "module": "_models", + "name": "PrivateUserDataResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1822 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 832, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1832 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 833, + "module": "_models", + "name": "bio", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1836 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['I started web scraping in 1985 using Altair BASIC.'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 834, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1837 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['Jane Doe'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 835, + "module": "_models", + "name": "picture_url", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1838 + } + ], + "type": { + "name": "Annotated[ AnyUrl | None, Field(alias='pictureUrl', examples=['https://apify.com/img/anonymous_user_picture.png']) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AnyUrl" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 836, + "module": "_models", + "name": "github_username", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1841 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='githubUsername', examples=['torvalds.'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 837, + "module": "_models", + "name": "website_url", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1842 + } + ], + "type": { + "name": "Annotated[AnyUrl | None, Field(alias='websiteUrl', examples=['http://www.example.com'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AnyUrl" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 838, + "module": "_models", + "name": "twitter_username", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1843 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='twitterUsername', examples=['@BillGates'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 833, + 836, + 832, + 834, + 835, + 838, + 837 + ], + "title": "Properties" + } + ], + "id": 831, + "module": "_models", + "name": "Profile", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1831 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 840, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1850 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 841, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1854 + } + ], + "type": { + "name": "RequestLockInfo", + "type": "reference", + "target": "895" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response containing updated lock information after prolonging a request lock." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 841, + 840 + ], + "title": "Properties" + } + ], + "id": 839, + "module": "_models", + "name": "ProlongRequestLockResponse", + "parsedDocstring": { + "text": "Response containing updated lock information after prolonging a request lock." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1847 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 843, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1859 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 844, + "module": "_models", + "name": "password", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1863 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 845, + "module": "_models", + "name": "groups", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1864 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ProxyGroup", + "target": "846" + } + ], + "target": "2199" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 845, + 843, + 844 + ], + "title": "Properties" + } + ], + "id": 842, + "module": "_models", + "name": "Proxy", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1858 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 847, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1869 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 848, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1873 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 849, + "module": "_models", + "name": "description", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1874 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 850, + "module": "_models", + "name": "available_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1875 + } + ], + "type": { + "name": "int", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 850, + 849, + 847, + 848 + ], + "title": "Properties" + } + ], + "id": 846, + "module": "_models", + "name": "ProxyGroup", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1868 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 852, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1880 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 853, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1884 + } + ], + "type": { + "name": "UserPublicInfo", + "type": "reference", + "target": "1325" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 853, + 852 + ], + "title": "Properties" + } + ], + "id": 851, + "module": "_models", + "name": "PublicUserDataResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1879 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 855, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1889 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 856, + "module": "_models", + "name": "error", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1893 + } + ], + "type": { + "name": "DatasetSchemaValidationError", + "type": "reference", + "target": "472" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 856, + 855 + ], + "title": "Properties" + } + ], + "id": 854, + "module": "_models", + "name": "PutItemResponseError", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1888 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 858, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1903 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The request body containing the item(s) to add to the dataset. Can be a single\nobject or an array of objects. Each object represents one dataset item." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 858 + ], + "title": "Properties" + } + ], + "id": 857, + "module": "_models", + "name": "PutItemsRequest", + "parsedDocstring": { + "text": "The request body containing the item(s) to add to the dataset. Can be a single\nobject or an array of objects. Each object represents one dataset item." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1897 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 860, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1916 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The request body contains the value to store in the record. The content type\nshould be specified in the Content-Type header." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 860 + ], + "title": "Properties" + } + ], + "id": 859, + "module": "_models", + "name": "PutRecordRequest", + "parsedDocstring": { + "text": "The request body contains the value to store in the record. The content type\nshould be specified in the Content-Type header." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1910 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 862, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1929 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The response body contains the value of the record. The content type of the response\nis determined by the Content-Type header stored with the record." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 862 + ], + "title": "Properties" + } + ], + "id": 861, + "module": "_models", + "name": "RecordResponse", + "parsedDocstring": { + "text": "The response body contains the value of the record. The content type of the response\nis determined by the Content-Type header stored with the record." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1923 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 864, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1937 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 865, + "module": "_models", + "name": "unique_key", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1941 + } + ], + "type": { + "name": "Annotated[ str | None, Field(alias='uniqueKey', examples=['GET|60d83e70|e3b0c442|https://apify.com']) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 866, + "module": "_models", + "name": "url", + "parsedDocstring": { + "text": "The URL of the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1947 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['https://apify.com'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 867, + "module": "_models", + "name": "method", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1951 + } + ], + "type": { + "name": "HttpMethod | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "HttpMethod", + "target": "1798" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of times this request has been retried." + } + ] + }, + "flags": {}, + "groups": [], + "id": 868, + "module": "_models", + "name": "retry_count", + "parsedDocstring": { + "text": "The number of times this request has been retried." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1952 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='retryCount', examples=[0])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The final URL that was loaded, after redirects (if any)." + } + ] + }, + "flags": {}, + "groups": [], + "id": 869, + "module": "_models", + "name": "loaded_url", + "parsedDocstring": { + "text": "The final URL that was loaded, after redirects (if any)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1956 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='loadedUrl', examples=['https://apify.com/jobs'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The request payload, typically used with POST or PUT requests." + } + ] + }, + "flags": {}, + "groups": [], + "id": 870, + "module": "_models", + "name": "payload", + "parsedDocstring": { + "text": "The request payload, typically used with POST or PUT requests." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1960 + } + ], + "type": { + "name": "Annotated[str | dict[str, Any] | None, Field(examples=[None])]", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP headers sent with the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 871, + "module": "_models", + "name": "headers", + "parsedDocstring": { + "text": "HTTP headers sent with the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1964 + } + ], + "type": { + "name": "Annotated[dict[str, Any] | None, Field(examples=[None])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 872, + "module": "_models", + "name": "user_data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1968 + } + ], + "type": { + "name": "Annotated[RequestUserData | None, Field(alias='userData')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestUserData", + "target": "956" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Indicates whether the request should not be retried if processing fails." + } + ] + }, + "flags": {}, + "groups": [], + "id": 873, + "module": "_models", + "name": "no_retry", + "parsedDocstring": { + "text": "Indicates whether the request should not be retried if processing fails." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1969 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='noRetry', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error messages recorded from failed processing attempts." + } + ] + }, + "flags": {}, + "groups": [], + "id": 874, + "module": "_models", + "name": "error_messages", + "parsedDocstring": { + "text": "Error messages recorded from failed processing attempts." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1973 + } + ], + "type": { + "name": "Annotated[list[str] | None, Field(alias='errorMessages', examples=[None])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timestamp when the request was marked as handled, if applicable." + } + ] + }, + "flags": {}, + "groups": [], + "id": 875, + "module": "_models", + "name": "handled_at", + "parsedDocstring": { + "text": "The timestamp when the request was marked as handled, if applicable." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1977 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='handledAt', examples=['2019-06-16T10:23:31.607Z'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 874, + 875, + 871, + 869, + 867, + 864, + 873, + 870, + 868, + 865, + 866, + 872 + ], + "title": "Properties" + } + ], + "id": 863, + "module": "_models", + "name": "RequestBase", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1936 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "Request", + "target": "876", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 877, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1987 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "RequestBase.model_config", + "target": 864, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 878, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1991 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['sbJ7klsdf7ujN9l'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4050, + "module": "_models", + "name": "unique_key", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1941 + } + ], + "type": { + "name": "Annotated[ str | None, Field(alias='uniqueKey', examples=['GET|60d83e70|e3b0c442|https://apify.com']) ]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBase.unique_key", + "target": 865, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4051, + "module": "_models", + "name": "url", + "parsedDocstring": { + "text": "The URL of the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1947 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['https://apify.com'])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBase.url", + "target": 866, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4052, + "module": "_models", + "name": "method", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1951 + } + ], + "type": { + "name": "HttpMethod | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "HttpMethod", + "target": "1798" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "RequestBase.method", + "target": 867, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of times this request has been retried." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4053, + "module": "_models", + "name": "retry_count", + "parsedDocstring": { + "text": "The number of times this request has been retried." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1952 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='retryCount', examples=[0])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBase.retry_count", + "target": 868, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The final URL that was loaded, after redirects (if any)." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4054, + "module": "_models", + "name": "loaded_url", + "parsedDocstring": { + "text": "The final URL that was loaded, after redirects (if any)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1956 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='loadedUrl', examples=['https://apify.com/jobs'])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBase.loaded_url", + "target": 869, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The request payload, typically used with POST or PUT requests." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4055, + "module": "_models", + "name": "payload", + "parsedDocstring": { + "text": "The request payload, typically used with POST or PUT requests." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1960 + } + ], + "type": { + "name": "Annotated[str | dict[str, Any] | None, Field(examples=[None])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBase.payload", + "target": 870, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP headers sent with the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4056, + "module": "_models", + "name": "headers", + "parsedDocstring": { + "text": "HTTP headers sent with the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1964 + } + ], + "type": { + "name": "Annotated[dict[str, Any] | None, Field(examples=[None])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBase.headers", + "target": 871, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4057, + "module": "_models", + "name": "user_data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1968 + } + ], + "type": { + "name": "Annotated[RequestUserData | None, Field(alias='userData')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestUserData", + "target": "956" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "RequestBase.user_data", + "target": 872, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Indicates whether the request should not be retried if processing fails." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4058, + "module": "_models", + "name": "no_retry", + "parsedDocstring": { + "text": "Indicates whether the request should not be retried if processing fails." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1969 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='noRetry', examples=[False])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBase.no_retry", + "target": 873, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Error messages recorded from failed processing attempts." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4059, + "module": "_models", + "name": "error_messages", + "parsedDocstring": { + "text": "Error messages recorded from failed processing attempts." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1973 + } + ], + "type": { + "name": "Annotated[list[str] | None, Field(alias='errorMessages', examples=[None])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBase.error_messages", + "target": 874, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timestamp when the request was marked as handled, if applicable." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4060, + "module": "_models", + "name": "handled_at", + "parsedDocstring": { + "text": "The timestamp when the request was marked as handled, if applicable." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1977 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='handledAt', examples=['2019-06-16T10:23:31.607Z'])]", + "type": "reference" + }, + "inheritedFrom": { + "name": "RequestBase.handled_at", + "target": 875, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request stored in the request queue, including its metadata and processing state." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4059, + 4060, + 4056, + 878, + 4054, + 4052, + 877, + 4058, + 4055, + 4053, + 4050, + 4051, + 4057 + ], + "title": "Properties" + } + ], + "id": 876, + "module": "_models", + "name": "Request", + "parsedDocstring": { + "text": "A request stored in the request queue, including its metadata and processing state." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1984 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "RequestBase", + "target": "863", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 880, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2001 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 881, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2005 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['sbJ7klsdf7ujN9l'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 882, + "module": "_models", + "name": "unique_key", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2009 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 883, + "module": "_models", + "name": "url", + "parsedDocstring": { + "text": "The URL of the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2013 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 884, + "module": "_models", + "name": "method", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2017 + } + ], + "type": { + "name": "HttpMethod | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "HttpMethod", + "target": "1798" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request that failed to be processed during a request queue operation and can be retried." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 881, + 884, + 880, + 882, + 883 + ], + "title": "Properties" + } + ], + "id": 879, + "module": "_models", + "name": "RequestDraft", + "parsedDocstring": { + "text": "A request that failed to be processed during a request queue operation and can be retried." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1998 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 886, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2024 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 887, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2028 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 888, + "module": "_models", + "name": "unique_key", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2032 + } + ], + "type": { + "name": "Annotated[ str | None, Field(alias='uniqueKey', examples=['GET|60d83e70|e3b0c442|https://apify.com']) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request that should be deleted, identified by its ID." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 887, + 886, + 888 + ], + "title": "Properties" + } + ], + "id": 885, + "module": "_models", + "name": "RequestDraftDeleteById", + "parsedDocstring": { + "text": "A request that should be deleted, identified by its ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2021 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 890, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2044 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 891, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2048 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['sbJ7klsdf7ujN9l'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + } + ] + }, + "flags": {}, + "groups": [], + "id": 892, + "module": "_models", + "name": "unique_key", + "parsedDocstring": { + "text": "A unique key used for request de-duplication. Requests with the same unique key are considered identical." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2052 + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request that should be deleted, identified by its unique key." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 891, + 890, + 892 + ], + "title": "Properties" + } + ], + "id": 889, + "module": "_models", + "name": "RequestDraftDeleteByUniqueKey", + "parsedDocstring": { + "text": "A request that should be deleted, identified by its unique key." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2041 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request that should be deleted." + } + ] + }, + "flags": {}, + "groups": [], + "id": 894, + "module": "_models", + "name": "root", + "parsedDocstring": { + "text": "A request that should be deleted." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2060 + } + ], + "type": { + "name": "Annotated[RequestDraftDeleteById | RequestDraftDeleteByUniqueKey, Field(title='RequestDraftDelete')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestDraftDeleteById", + "target": "885" + }, + { + "type": "reference", + "name": "RequestDraftDeleteByUniqueKey", + "target": "889" + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 894 + ], + "title": "Properties" + } + ], + "id": 893, + "module": "_models", + "name": "RequestDraftDelete", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2059 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 896, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2070 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timestamp when the lock on this request expires." + } + ] + }, + "flags": {}, + "groups": [], + "id": 897, + "module": "_models", + "name": "lock_expires_at", + "parsedDocstring": { + "text": "The timestamp when the lock on this request expires." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2074 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Information about a request lock." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 897, + 896 + ], + "title": "Properties" + } + ], + "id": 895, + "module": "_models", + "name": "RequestLockInfo", + "parsedDocstring": { + "text": "Information about a request lock." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2067 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 899, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2084 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 900, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2088 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 901, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "The name of the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2092 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['some-name'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the user who owns the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 902, + "module": "_models", + "name": "user_id", + "parsedDocstring": { + "text": "The ID of the user who owns the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2096 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timestamp when the request queue was created." + } + ] + }, + "flags": {}, + "groups": [], + "id": 903, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "The timestamp when the request queue was created." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2100 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 904, + "module": "_models", + "name": "modified_at", + "parsedDocstring": { + "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2104 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timestamp when the request queue was last accessed." + } + ] + }, + "flags": {}, + "groups": [], + "id": 905, + "module": "_models", + "name": "accessed_at", + "parsedDocstring": { + "text": "The timestamp when the request queue was last accessed." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2108 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of requests in the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 906, + "module": "_models", + "name": "total_request_count", + "parsedDocstring": { + "text": "The total number of requests in the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2112 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of requests that have been handled." + } + ] + }, + "flags": {}, + "groups": [], + "id": 907, + "module": "_models", + "name": "handled_request_count", + "parsedDocstring": { + "text": "The number of requests that have been handled." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2116 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of requests that are pending and have not been handled yet." + } + ] + }, + "flags": {}, + "groups": [], + "id": 908, + "module": "_models", + "name": "pending_request_count", + "parsedDocstring": { + "text": "The number of requests that are pending and have not been handled yet." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2120 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the request queue has been accessed by multiple different clients." + } + ] + }, + "flags": {}, + "groups": [], + "id": 909, + "module": "_models", + "name": "had_multiple_clients", + "parsedDocstring": { + "text": "Whether the request queue has been accessed by multiple different clients." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2124 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL to view the request queue in the Apify console." + } + ] + }, + "flags": {}, + "groups": [], + "id": 910, + "module": "_models", + "name": "console_url", + "parsedDocstring": { + "text": "The URL to view the request queue in the Apify console." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2128 + } + ], + "type": { + "name": "AnyUrl", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 911, + "module": "_models", + "name": "stats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2134 + } + ], + "type": { + "name": "RequestQueueStats | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestQueueStats", + "target": "938" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 912, + "module": "_models", + "name": "general_access", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2135 + } + ], + "type": { + "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "GeneralAccess", + "target": "1797" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A request queue object containing metadata and statistics." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 905, + 910, + 903, + 912, + 909, + 907, + 900, + 899, + 904, + 901, + 908, + 911, + 906, + 902 + ], + "title": "Properties" + } + ], + "id": 898, + "module": "_models", + "name": "RequestQueue", + "parsedDocstring": { + "text": "A request queue object containing metadata and statistics." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2081 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 914, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2142 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of requests returned." + } + ] + }, + "flags": {}, + "groups": [], + "id": 915, + "module": "_models", + "name": "limit", + "parsedDocstring": { + "text": "The maximum number of requests returned." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2146 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 916, + "module": "_models", + "name": "queue_modified_at", + "parsedDocstring": { + "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2150 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the request queue has been accessed by multiple different clients." + } + ] + }, + "flags": {}, + "groups": [], + "id": 917, + "module": "_models", + "name": "had_multiple_clients", + "parsedDocstring": { + "text": "Whether the request queue has been accessed by multiple different clients." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2154 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The array of requests from the request queue head." + } + ] + }, + "flags": {}, + "groups": [], + "id": 918, + "module": "_models", + "name": "items", + "parsedDocstring": { + "text": "The array of requests from the request queue head." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2158 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "HeadRequest", + "target": "581" + } + ], + "target": "2199" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A batch of requests from the request queue head without locking." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 917, + 918, + 915, + 914, + 916 + ], + "title": "Properties" + } + ], + "id": 913, + "module": "_models", + "name": "RequestQueueHead", + "parsedDocstring": { + "text": "A batch of requests from the request queue head without locking." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2139 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 920, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2168 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 921, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2172 + } + ], + "type": { + "name": "RequestQueue", + "type": "reference", + "target": "898" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response containing request queue data." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 921, + 920 + ], + "title": "Properties" + } + ], + "id": 919, + "module": "_models", + "name": "RequestQueueResponse", + "parsedDocstring": { + "text": "Response containing request queue data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2165 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 923, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2179 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 924, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2183 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 925, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "The name of the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2187 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the user who owns the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 926, + "module": "_models", + "name": "user_id", + "parsedDocstring": { + "text": "The ID of the user who owns the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2191 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The username of the user who owns the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 927, + "module": "_models", + "name": "username", + "parsedDocstring": { + "text": "The username of the user who owns the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2195 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timestamp when the request queue was created." + } + ] + }, + "flags": {}, + "groups": [], + "id": 928, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "The timestamp when the request queue was created." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2199 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 929, + "module": "_models", + "name": "modified_at", + "parsedDocstring": { + "text": "The timestamp when the request queue was last modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2203 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timestamp when the request queue was last accessed." + } + ] + }, + "flags": {}, + "groups": [], + "id": 930, + "module": "_models", + "name": "accessed_at", + "parsedDocstring": { + "text": "The timestamp when the request queue was last accessed." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2207 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timestamp when the request queue will expire and be deleted." + } + ] + }, + "flags": {}, + "groups": [], + "id": 931, + "module": "_models", + "name": "expire_at", + "parsedDocstring": { + "text": "The timestamp when the request queue will expire and be deleted." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2211 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='expireAt', examples=['2019-06-02T17:15:06.751Z'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of requests in the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 932, + "module": "_models", + "name": "total_request_count", + "parsedDocstring": { + "text": "The total number of requests in the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2215 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of requests that have been handled." + } + ] + }, + "flags": {}, + "groups": [], + "id": 933, + "module": "_models", + "name": "handled_request_count", + "parsedDocstring": { + "text": "The number of requests that have been handled." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2219 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of requests that are pending and have not been handled yet." + } + ] + }, + "flags": {}, + "groups": [], + "id": 934, + "module": "_models", + "name": "pending_request_count", + "parsedDocstring": { + "text": "The number of requests that are pending and have not been handled yet." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2223 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Actor that created this request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 935, + "module": "_models", + "name": "act_id", + "parsedDocstring": { + "text": "The ID of the Actor that created this request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2227 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='actId')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Actor run that created this request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 936, + "module": "_models", + "name": "act_run_id", + "parsedDocstring": { + "text": "The ID of the Actor run that created this request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2231 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='actRunId')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the request queue has been accessed by multiple different clients." + } + ] + }, + "flags": {}, + "groups": [], + "id": 937, + "module": "_models", + "name": "had_multiple_clients", + "parsedDocstring": { + "text": "Whether the request queue has been accessed by multiple different clients." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2235 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A shortened request queue object for list responses." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 930, + 935, + 936, + 928, + 931, + 937, + 933, + 924, + 923, + 929, + 925, + 934, + 932, + 926, + 927 + ], + "title": "Properties" + } + ], + "id": 922, + "module": "_models", + "name": "RequestQueueShort", + "parsedDocstring": { + "text": "A shortened request queue object for list responses." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2176 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 939, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2245 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of delete operations performed on the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 940, + "module": "_models", + "name": "delete_count", + "parsedDocstring": { + "text": "The number of delete operations performed on the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2249 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='deleteCount', examples=[0])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of times requests from the head were read." + } + ] + }, + "flags": {}, + "groups": [], + "id": 941, + "module": "_models", + "name": "head_item_read_count", + "parsedDocstring": { + "text": "The number of times requests from the head were read." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2253 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='headItemReadCount', examples=[5])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of read operations performed on the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 942, + "module": "_models", + "name": "read_count", + "parsedDocstring": { + "text": "The total number of read operations performed on the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2257 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='readCount', examples=[100])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total storage size in bytes used by the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 943, + "module": "_models", + "name": "storage_bytes", + "parsedDocstring": { + "text": "The total storage size in bytes used by the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2261 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='storageBytes', examples=[1024])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of write operations performed on the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 944, + "module": "_models", + "name": "write_count", + "parsedDocstring": { + "text": "The total number of write operations performed on the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2265 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='writeCount', examples=[10])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statistics about request queue operations and storage." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 940, + 941, + 939, + 942, + 943, + 944 + ], + "title": "Properties" + } + ], + "id": 938, + "module": "_models", + "name": "RequestQueueStats", + "parsedDocstring": { + "text": "Statistics about request queue operations and storage." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2242 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 946, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2275 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the default request queue for this run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 947, + "module": "_models", + "name": "default", + "parsedDocstring": { + "text": "ID of the default request queue for this run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2279 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['FL35cSF7jrxr3BY39'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Aliased request queue IDs for this run." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 947, + 946 + ], + "title": "Properties" + } + ], + "id": 945, + "module": "_models", + "name": "RequestQueues", + "parsedDocstring": { + "text": "Aliased request queue IDs for this run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2272 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 949, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2289 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier assigned to the request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 950, + "module": "_models", + "name": "request_id", + "parsedDocstring": { + "text": "A unique identifier assigned to the request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2293 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Indicates whether a request with the same unique key already existed in the request queue. If true, no new request was created." + } + ] + }, + "flags": {}, + "groups": [], + "id": 951, + "module": "_models", + "name": "was_already_present", + "parsedDocstring": { + "text": "Indicates whether a request with the same unique key already existed in the request queue. If true, no new request was created." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2297 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Indicates whether a request with the same unique key has already been processed by the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 952, + "module": "_models", + "name": "was_already_handled", + "parsedDocstring": { + "text": "Indicates whether a request with the same unique key has already been processed by the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2301 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Result of registering a request in the request queue, either by adding a new request or updating an existing one." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 949, + 950, + 952, + 951 + ], + "title": "Properties" + } + ], + "id": 948, + "module": "_models", + "name": "RequestRegistration", + "parsedDocstring": { + "text": "Result of registering a request in the request queue, either by adding a new request or updating an existing one." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2286 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 954, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2311 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 955, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2315 + } + ], + "type": { + "name": "Request", + "type": "reference", + "target": "876" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response containing a single request from the request queue." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 955, + 954 + ], + "title": "Properties" + } + ], + "id": 953, + "module": "_models", + "name": "RequestResponse", + "parsedDocstring": { + "text": "Response containing a single request from the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2308 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 957, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2322 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Custom user data attached to the request. Can contain arbitrary fields." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 957 + ], + "title": "Properties" + } + ], + "id": 956, + "module": "_models", + "name": "RequestUserData", + "parsedDocstring": { + "text": "Custom user data attached to the request. Can contain arbitrary fields." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2319 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 959, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2332 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unique identifier of the Actor run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 960, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "Unique identifier of the Actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2336 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the Actor that was run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 961, + "module": "_models", + "name": "act_id", + "parsedDocstring": { + "text": "ID of the Actor that was run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2340 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the user who started the run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 962, + "module": "_models", + "name": "user_id", + "parsedDocstring": { + "text": "ID of the user who started the run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2344 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the Actor task, if the run was started from a task." + } + ] + }, + "flags": {}, + "groups": [], + "id": 963, + "module": "_models", + "name": "actor_task_id", + "parsedDocstring": { + "text": "ID of the Actor task, if the run was started from a task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2348 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='actorTaskId', examples=['KJHSKHausidyaJKHs'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Time when the Actor run started." + } + ] + }, + "flags": {}, + "groups": [], + "id": 964, + "module": "_models", + "name": "started_at", + "parsedDocstring": { + "text": "Time when the Actor run started." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2352 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Time when the Actor run finished." + } + ] + }, + "flags": {}, + "groups": [], + "id": 965, + "module": "_models", + "name": "finished_at", + "parsedDocstring": { + "text": "Time when the Actor run finished." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2356 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Current status of the Actor run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 966, + "module": "_models", + "name": "status", + "parsedDocstring": { + "text": "Current status of the Actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2362 + } + ], + "type": { + "name": "ActorJobStatus", + "type": "reference", + "target": "1794" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Detailed message about the run status." + } + ] + }, + "flags": {}, + "groups": [], + "id": 967, + "module": "_models", + "name": "status_message", + "parsedDocstring": { + "text": "Detailed message about the run status." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2366 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='statusMessage', examples=['Actor is running'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the status message is terminal (final)." + } + ] + }, + "flags": {}, + "groups": [], + "id": 968, + "module": "_models", + "name": "is_status_message_terminal", + "parsedDocstring": { + "text": "Whether the status message is terminal (final)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2370 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='isStatusMessageTerminal', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Metadata about the Actor run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 969, + "module": "_models", + "name": "meta", + "parsedDocstring": { + "text": "Metadata about the Actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2374 + } + ], + "type": { + "name": "RunMeta", + "type": "reference", + "target": "992" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Pricing information for the Actor." + } + ] + }, + "flags": {}, + "groups": [], + "id": 970, + "module": "_models", + "name": "pricing_info", + "parsedDocstring": { + "text": "Pricing information for the Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2378 + } + ], + "type": { + "name": "Annotated[ PayPerEventActorPricingInfo | PricePerDatasetItemActorPricingInfo | FlatPricePerMonthActorPricingInfo | FreeActorPricingInfo | None, Field(alias='pricingInfo', discriminator='pricing_model', title='ActorRunPricingInfo'), ]", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "PayPerEventActorPricingInfo", + "target": "786" + }, + { + "type": "reference", + "name": "PricePerDatasetItemActorPricingInfo", + "target": "813" + } + ] + }, + { + "type": "reference", + "name": "FlatPricePerMonthActorPricingInfo", + "target": "570" + } + ] + }, + { + "type": "reference", + "name": "FreeActorPricingInfo", + "target": "575" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statistics of the Actor run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 971, + "module": "_models", + "name": "stats", + "parsedDocstring": { + "text": "Statistics of the Actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2389 + } + ], + "type": { + "name": "RunStats", + "type": "reference", + "target": "1025" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A map of charged event types to their counts. The keys are event type identifiers defined by the Actor's pricing model (pay-per-event), and the values are the number of times each event was charged during this run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 972, + "module": "_models", + "name": "charged_event_counts", + "parsedDocstring": { + "text": "A map of charged event types to their counts. The keys are event type identifiers defined by the Actor's pricing model (pay-per-event), and the values are the number of times each event was charged during this run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2393 + } + ], + "type": { + "name": "Annotated[ dict[str, int] | None, Field(alias='chargedEventCounts', examples=[{'actor-start': 1, 'page-crawled': 150, 'data-extracted': 75}]), ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "int" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configuration options for the Actor run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 973, + "module": "_models", + "name": "options", + "parsedDocstring": { + "text": "Configuration options for the Actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2400 + } + ], + "type": { + "name": "RunOptions", + "type": "reference", + "target": "999" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the Actor build used for this run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 974, + "module": "_models", + "name": "build_id", + "parsedDocstring": { + "text": "ID of the Actor build used for this run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2404 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Exit code of the Actor run process." + } + ] + }, + "flags": {}, + "groups": [], + "id": 975, + "module": "_models", + "name": "exit_code", + "parsedDocstring": { + "text": "Exit code of the Actor run process." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2408 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='exitCode', examples=[0])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "General access level for the Actor run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 976, + "module": "_models", + "name": "general_access", + "parsedDocstring": { + "text": "General access level for the Actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2412 + } + ], + "type": { + "name": "GeneralAccess", + "type": "reference", + "target": "1797" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the default key-value store for this run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 977, + "module": "_models", + "name": "default_key_value_store_id", + "parsedDocstring": { + "text": "ID of the default key-value store for this run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2416 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the default dataset for this run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 978, + "module": "_models", + "name": "default_dataset_id", + "parsedDocstring": { + "text": "ID of the default dataset for this run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2420 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the default request queue for this run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 979, + "module": "_models", + "name": "default_request_queue_id", + "parsedDocstring": { + "text": "ID of the default request queue for this run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2424 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A map of aliased storage IDs associated with this run, grouped by storage type." + } + ] + }, + "flags": {}, + "groups": [], + "id": 980, + "module": "_models", + "name": "storage_ids", + "parsedDocstring": { + "text": "A map of aliased storage IDs associated with this run, grouped by storage type." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2428 + } + ], + "type": { + "name": "Annotated[StorageIds | None, Field(alias='storageIds')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "StorageIds", + "target": "1167" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Build number of the Actor build used for this run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 981, + "module": "_models", + "name": "build_number", + "parsedDocstring": { + "text": "Build number of the Actor build used for this run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2432 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='buildNumber', examples=['0.0.36'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "URL of the container running the Actor." + } + ] + }, + "flags": {}, + "groups": [], + "id": 982, + "module": "_models", + "name": "container_url", + "parsedDocstring": { + "text": "URL of the container running the Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2436 + } + ], + "type": { + "name": "Annotated[ AnyUrl | None, Field(alias='containerUrl', examples=['https://g8kd8kbc5ge8.runs.apify.net']) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AnyUrl" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the container's HTTP server is ready to accept requests." + } + ] + }, + "flags": {}, + "groups": [], + "id": 983, + "module": "_models", + "name": "is_container_server_ready", + "parsedDocstring": { + "text": "Whether the container's HTTP server is ready to accept requests." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2442 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='isContainerServerReady', examples=[True])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the git branch used for the Actor build." + } + ] + }, + "flags": {}, + "groups": [], + "id": 984, + "module": "_models", + "name": "git_branch_name", + "parsedDocstring": { + "text": "Name of the git branch used for the Actor build." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2446 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='gitBranchName', examples=['master'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource usage statistics for the run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 985, + "module": "_models", + "name": "usage", + "parsedDocstring": { + "text": "Resource usage statistics for the run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2450 + } + ], + "type": { + "name": "RunUsage | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "RunUsage", + "target": "1047" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Total cost in USD for this run. Represents what you actually pay. For run owners: includes platform usage (compute units) and/or event costs depending on the Actor's pricing model. For run non-owners: only available for Pay-Per-Event Actors (event costs only). Requires authentication token to access." + } + ] + }, + "flags": {}, + "groups": [], + "id": 986, + "module": "_models", + "name": "usage_total_usd", + "parsedDocstring": { + "text": "Total cost in USD for this run. Represents what you actually pay. For run owners: includes platform usage (compute units) and/or event costs depending on the Actor's pricing model. For run non-owners: only available for Pay-Per-Event Actors (event costs only). Requires authentication token to access." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2454 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='usageTotalUsd', examples=[0.2654])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Platform usage costs breakdown in USD. Only present if you own the run AND are paying for platform usage (Pay-Per-Usage, Rental, or Pay-Per-Event with usage costs like standby Actors). Not available for standard Pay-Per-Event Actors. Requires authentication token to access." + } + ] + }, + "flags": {}, + "groups": [], + "id": 987, + "module": "_models", + "name": "usage_usd", + "parsedDocstring": { + "text": "Platform usage costs breakdown in USD. Only present if you own the run AND are paying for platform usage (Pay-Per-Usage, Rental, or Pay-Per-Event with usage costs like standby Actors). Not available for standard Pay-Per-Event Actors. Requires authentication token to access." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2458 + } + ], + "type": { + "name": "Annotated[RunUsageUsd | None, Field(alias='usageUsd')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "RunUsageUsd", + "target": "1061" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of metamorph events that occurred during the run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 988, + "module": "_models", + "name": "metamorphs", + "parsedDocstring": { + "text": "List of metamorph events that occurred during the run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2462 + } + ], + "type": { + "name": "list[Metamorph] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "Metamorph", + "target": "730" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Represents an Actor run and its associated data." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 961, + 963, + 974, + 981, + 972, + 982, + 978, + 977, + 979, + 975, + 965, + 976, + 984, + 960, + 983, + 968, + 969, + 988, + 959, + 973, + 970, + 964, + 971, + 966, + 967, + 980, + 985, + 986, + 987, + 962 + ], + "title": "Properties" + } + ], + "id": 958, + "module": "_models", + "name": "Run", + "parsedDocstring": { + "text": "Represents an Actor run and its associated data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2329 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 990, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2470 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "ErrorDetail.model_config", + "target": 552, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Machine-processable error type identifier." + } + ] + }, + "flags": {}, + "groups": [], + "id": 991, + "module": "_models", + "name": "type", + "parsedDocstring": { + "text": "Machine-processable error type identifier." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2474 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "run-failed" + } + ] + }, + "overwrites": { + "name": "ErrorDetail.type", + "target": 553, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Human-readable error message describing what went wrong." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4047, + "module": "_models", + "name": "message", + "parsedDocstring": { + "text": "Human-readable error message describing what went wrong." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1007 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ErrorDetail.message", + "target": 554, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4047, + 990, + 991 + ], + "title": "Properties" + } + ], + "id": 989, + "module": "_models", + "name": "RunFailedErrorDetail", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2469 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ErrorDetail", + "target": "551", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 993, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2482 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 994, + "module": "_models", + "name": "origin", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2486 + } + ], + "type": { + "name": "RunOrigin", + "type": "reference", + "target": "1799" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "IP address of the client that started the run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 995, + "module": "_models", + "name": "client_ip", + "parsedDocstring": { + "text": "IP address of the client that started the run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2487 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='clientIp')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "User agent of the client that started the run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 996, + "module": "_models", + "name": "user_agent", + "parsedDocstring": { + "text": "User agent of the client that started the run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2491 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='userAgent')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the schedule that triggered the run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 997, + "module": "_models", + "name": "schedule_id", + "parsedDocstring": { + "text": "ID of the schedule that triggered the run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2495 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='scheduleId')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Time when the run was scheduled." + } + ] + }, + "flags": {}, + "groups": [], + "id": 998, + "module": "_models", + "name": "scheduled_at", + "parsedDocstring": { + "text": "Time when the run was scheduled." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2499 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='scheduledAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 995, + 993, + 994, + 997, + 998, + 996 + ], + "title": "Properties" + } + ], + "id": 992, + "module": "_models", + "name": "RunMeta", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2481 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1000, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2507 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1001, + "module": "_models", + "name": "build", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2511 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1002, + "module": "_models", + "name": "timeout_secs", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2512 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1003, + "module": "_models", + "name": "memory_mbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2513 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1004, + "module": "_models", + "name": "disk_mbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2514 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1005, + "module": "_models", + "name": "max_items", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2515 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='maxItems', examples=[1000], ge=1)]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1006, + "module": "_models", + "name": "max_total_charge_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2516 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='maxTotalChargeUsd', examples=[5], ge=0.0)]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1001, + 1004, + 1005, + 1006, + 1003, + 1000, + 1002 + ], + "title": "Properties" + } + ], + "id": 999, + "module": "_models", + "name": "RunOptions", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2506 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1008, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2521 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1009, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2525 + } + ], + "type": { + "name": "Run", + "type": "reference", + "target": "958" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1009, + 1008 + ], + "title": "Properties" + } + ], + "id": 1007, + "module": "_models", + "name": "RunResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2520 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1011, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2530 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1012, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2534 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1013, + "module": "_models", + "name": "act_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2535 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1014, + "module": "_models", + "name": "actor_task_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2536 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='actorTaskId', examples=['KJHSKHausidyaJKHs'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1015, + "module": "_models", + "name": "status", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2537 + } + ], + "type": { + "name": "ActorJobStatus", + "type": "reference", + "target": "1794" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1016, + "module": "_models", + "name": "started_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2538 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1017, + "module": "_models", + "name": "finished_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2539 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-12-12T09:30:12.202Z'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1018, + "module": "_models", + "name": "build_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2542 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1019, + "module": "_models", + "name": "build_number", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2543 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='buildNumber', examples=['0.0.2'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1020, + "module": "_models", + "name": "meta", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2544 + } + ], + "type": { + "name": "RunMeta", + "type": "reference", + "target": "992" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1021, + "module": "_models", + "name": "usage_total_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2545 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1022, + "module": "_models", + "name": "default_key_value_store_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2546 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1023, + "module": "_models", + "name": "default_dataset_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2547 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1024, + "module": "_models", + "name": "default_request_queue_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2548 + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1013, + 1014, + 1018, + 1019, + 1023, + 1022, + 1024, + 1017, + 1012, + 1020, + 1011, + 1016, + 1015, + 1021 + ], + "title": "Properties" + } + ], + "id": 1010, + "module": "_models", + "name": "RunShort", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2529 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1026, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2553 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1027, + "module": "_models", + "name": "input_body_len", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2557 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='inputBodyLen', examples=[240], ge=0)]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1028, + "module": "_models", + "name": "migration_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2558 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='migrationCount', examples=[0], ge=0)]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1029, + "module": "_models", + "name": "reboot_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2559 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='rebootCount', examples=[0], ge=0)]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1030, + "module": "_models", + "name": "restart_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2560 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1031, + "module": "_models", + "name": "resurrect_count", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2561 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1032, + "module": "_models", + "name": "mem_avg_bytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2562 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='memAvgBytes', examples=[267874071.9])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1033, + "module": "_models", + "name": "mem_max_bytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2563 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='memMaxBytes', examples=[404713472], ge=0)]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1034, + "module": "_models", + "name": "mem_current_bytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2564 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='memCurrentBytes', examples=[0], ge=0)]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1035, + "module": "_models", + "name": "cpu_avg_usage", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2565 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='cpuAvgUsage', examples=[33.7532101107538])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1036, + "module": "_models", + "name": "cpu_max_usage", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2566 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='cpuMaxUsage', examples=[169.650735534941])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1037, + "module": "_models", + "name": "cpu_current_usage", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2567 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='cpuCurrentUsage', examples=[0])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1038, + "module": "_models", + "name": "net_rx_bytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2568 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='netRxBytes', examples=[103508042], ge=0)]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1039, + "module": "_models", + "name": "net_tx_bytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2569 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='netTxBytes', examples=[4854600], ge=0)]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1040, + "module": "_models", + "name": "duration_millis", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2570 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='durationMillis', examples=[248472], ge=0)]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1041, + "module": "_models", + "name": "run_time_secs", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2571 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='runTimeSecs', examples=[248.472], ge=0.0)]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1042, + "module": "_models", + "name": "metamorph", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2572 + } + ], + "type": { + "name": "Annotated[int | None, Field(examples=[0], ge=0)]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1043, + "module": "_models", + "name": "compute_units", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2573 + } + ], + "type": { + "name": "float", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1043, + 1035, + 1037, + 1036, + 1040, + 1027, + 1032, + 1034, + 1033, + 1042, + 1028, + 1026, + 1038, + 1039, + 1029, + 1030, + 1031, + 1041 + ], + "title": "Properties" + } + ], + "id": 1025, + "module": "_models", + "name": "RunStats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2552 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1045, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2578 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "ErrorDetail.model_config", + "target": 552, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Machine-processable error type identifier." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1046, + "module": "_models", + "name": "type", + "parsedDocstring": { + "text": "Machine-processable error type identifier." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2582 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "run-timeout-exceeded" + } + ] + }, + "overwrites": { + "name": "ErrorDetail.type", + "target": 553, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Human-readable error message describing what went wrong." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4048, + "module": "_models", + "name": "message", + "parsedDocstring": { + "text": "Human-readable error message describing what went wrong." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1007 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ErrorDetail.message", + "target": 554, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4048, + 1045, + 1046 + ], + "title": "Properties" + } + ], + "id": 1044, + "module": "_models", + "name": "RunTimeoutExceededErrorDetail", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2577 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ErrorDetail", + "target": "551", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1048, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2590 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1049, + "module": "_models", + "name": "actor_compute_units", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2594 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='ACTOR_COMPUTE_UNITS', examples=[3])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1050, + "module": "_models", + "name": "dataset_reads", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2595 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='DATASET_READS', examples=[4])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1051, + "module": "_models", + "name": "dataset_writes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2596 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='DATASET_WRITES', examples=[4])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1052, + "module": "_models", + "name": "key_value_store_reads", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2597 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='KEY_VALUE_STORE_READS', examples=[5])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1053, + "module": "_models", + "name": "key_value_store_writes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2598 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='KEY_VALUE_STORE_WRITES', examples=[3])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1054, + "module": "_models", + "name": "key_value_store_lists", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2599 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='KEY_VALUE_STORE_LISTS', examples=[5])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1055, + "module": "_models", + "name": "request_queue_reads", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2600 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='REQUEST_QUEUE_READS', examples=[2])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1056, + "module": "_models", + "name": "request_queue_writes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2601 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='REQUEST_QUEUE_WRITES', examples=[1])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1057, + "module": "_models", + "name": "data_transfer_internal_gbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2602 + } + ], + "type": { + "name": "Annotated[ float | None, Field(alias='DATA_TRANSFER_INTERNAL_GBYTES', examples=[1]) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1058, + "module": "_models", + "name": "data_transfer_external_gbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2605 + } + ], + "type": { + "name": "Annotated[ float | None, Field(alias='DATA_TRANSFER_EXTERNAL_GBYTES', examples=[3]) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1059, + "module": "_models", + "name": "proxy_residential_transfer_gbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2608 + } + ], + "type": { + "name": "Annotated[ float | None, Field(alias='PROXY_RESIDENTIAL_TRANSFER_GBYTES', examples=[34]) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1060, + "module": "_models", + "name": "proxy_serps", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2611 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='PROXY_SERPS', examples=[3])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1049, + 1058, + 1057, + 1050, + 1051, + 1054, + 1052, + 1053, + 1048, + 1059, + 1060, + 1055, + 1056 + ], + "title": "Properties" + } + ], + "id": 1047, + "module": "_models", + "name": "RunUsage", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2589 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1062, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2618 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1063, + "module": "_models", + "name": "actor_compute_units", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2622 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='ACTOR_COMPUTE_UNITS', examples=[0.0003])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1064, + "module": "_models", + "name": "dataset_reads", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2623 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='DATASET_READS', examples=[0.0001])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1065, + "module": "_models", + "name": "dataset_writes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2624 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='DATASET_WRITES', examples=[0.0001])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1066, + "module": "_models", + "name": "key_value_store_reads", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2625 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='KEY_VALUE_STORE_READS', examples=[0.0001])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1067, + "module": "_models", + "name": "key_value_store_writes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2626 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='KEY_VALUE_STORE_WRITES', examples=[5e-05])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1068, + "module": "_models", + "name": "key_value_store_lists", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2627 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='KEY_VALUE_STORE_LISTS', examples=[0.0001])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1069, + "module": "_models", + "name": "request_queue_reads", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2628 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='REQUEST_QUEUE_READS', examples=[0.0001])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1070, + "module": "_models", + "name": "request_queue_writes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2629 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='REQUEST_QUEUE_WRITES', examples=[0.0001])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1071, + "module": "_models", + "name": "data_transfer_internal_gbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2630 + } + ], + "type": { + "name": "Annotated[ float | None, Field(alias='DATA_TRANSFER_INTERNAL_GBYTES', examples=[0.001]) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1072, + "module": "_models", + "name": "data_transfer_external_gbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2633 + } + ], + "type": { + "name": "Annotated[ float | None, Field(alias='DATA_TRANSFER_EXTERNAL_GBYTES', examples=[0.003]) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1073, + "module": "_models", + "name": "proxy_residential_transfer_gbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2636 + } + ], + "type": { + "name": "Annotated[ float | None, Field(alias='PROXY_RESIDENTIAL_TRANSFER_GBYTES', examples=[0.034]) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1074, + "module": "_models", + "name": "proxy_serps", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2639 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='PROXY_SERPS', examples=[0.003])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource usage costs in USD. All values are monetary amounts in US dollars." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1063, + 1072, + 1071, + 1064, + 1065, + 1068, + 1066, + 1067, + 1062, + 1073, + 1074, + 1069, + 1070 + ], + "title": "Properties" + } + ], + "id": 1061, + "module": "_models", + "name": "RunUsageUsd", + "parsedDocstring": { + "text": "Resource usage costs in USD. All values are monetary amounts in US dollars." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2615 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1076, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2644 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1077, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2648 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1078, + "module": "_models", + "name": "type", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2649 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "RUN_ACTOR" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1079, + "module": "_models", + "name": "actor_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2650 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1080, + "module": "_models", + "name": "run_input", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2651 + } + ], + "type": { + "name": "Annotated[ScheduleActionRunInput | None, Field(alias='runInput')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ScheduleActionRunInput", + "target": "1088" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1081, + "module": "_models", + "name": "run_options", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2652 + } + ], + "type": { + "name": "Annotated[TaskOptions | None, Field(alias='runOptions')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "TaskOptions", + "target": "1215" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1079, + 1077, + 1076, + 1080, + 1081, + 1078 + ], + "title": "Properties" + } + ], + "id": 1075, + "module": "_models", + "name": "ScheduleActionRunActor", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2643 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1083, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2657 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1084, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2661 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1085, + "module": "_models", + "name": "type", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2662 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "RUN_ACTOR_TASK" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1086, + "module": "_models", + "name": "actor_task_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2663 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1087, + "module": "_models", + "name": "input", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2664 + } + ], + "type": { + "name": "dict[str, Any] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1086, + 1084, + 1087, + 1083, + 1085 + ], + "title": "Properties" + } + ], + "id": 1082, + "module": "_models", + "name": "ScheduleActionRunActorTask", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2656 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1089, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2669 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1090, + "module": "_models", + "name": "body", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2673 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['{\\\\n \"foo\": \"actor\"\\\\n}'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1091, + "module": "_models", + "name": "content_type", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2674 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='contentType', examples=['application/json; charset=utf-8'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1090, + 1091, + 1089 + ], + "title": "Properties" + } + ], + "id": 1088, + "module": "_models", + "name": "ScheduleActionRunInput", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2668 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1093, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2679 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1094, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2683 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1095, + "module": "_models", + "name": "type", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2684 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "RUN_ACTOR" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1096, + "module": "_models", + "name": "actor_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2685 + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1096, + 1094, + 1093, + 1095 + ], + "title": "Properties" + } + ], + "id": 1092, + "module": "_models", + "name": "ScheduleActionShortRunActor", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2678 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1098, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2690 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1099, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2694 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1100, + "module": "_models", + "name": "type", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2695 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "RUN_ACTOR_TASK" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1101, + "module": "_models", + "name": "actor_task_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2696 + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1101, + 1099, + 1098, + 1100 + ], + "title": "Properties" + } + ], + "id": 1097, + "module": "_models", + "name": "ScheduleActionShortRunActorTask", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2689 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1103, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2701 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1104, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2705 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1105, + "module": "_models", + "name": "user_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2706 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1106, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2707 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1107, + "module": "_models", + "name": "cron_expression", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2708 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1108, + "module": "_models", + "name": "timezone", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2709 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1109, + "module": "_models", + "name": "is_enabled", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2710 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1110, + "module": "_models", + "name": "is_exclusive", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2711 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1111, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2712 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1112, + "module": "_models", + "name": "modified_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2713 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1113, + "module": "_models", + "name": "next_run_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2714 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='nextRunAt', examples=['2019-04-12T07:34:10.202Z'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1114, + "module": "_models", + "name": "last_run_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2715 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='lastRunAt', examples=['2019-04-12T07:33:10.202Z'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1111, + 1107, + 1104, + 1109, + 1110, + 1114, + 1103, + 1112, + 1106, + 1113, + 1108, + 1105 + ], + "title": "Properties" + } + ], + "id": 1102, + "module": "_models", + "name": "ScheduleBase", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2700 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "Schedule", + "target": "1115", + "type": "reference" + }, + { + "name": "ScheduleShort", + "target": "1152", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1116, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2720 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "ScheduleBase.model_config", + "target": 1103, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1117, + "module": "_models", + "name": "description", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2724 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['Schedule of actor ...'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1118, + "module": "_models", + "name": "title", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2725 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1119, + "module": "_models", + "name": "actions", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2726 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "ScheduleActionRunActor", + "target": "1075" + }, + { + "type": "reference", + "name": "ScheduleActionRunActorTask", + "target": "1082" + } + ] + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4025, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2705 + } + ], + "type": { + "name": "str", + "type": "reference" + }, + "inheritedFrom": { + "name": "ScheduleBase.id", + "target": 1104, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4026, + "module": "_models", + "name": "user_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2706 + } + ], + "type": { + "name": "str", + "type": "reference" + }, + "inheritedFrom": { + "name": "ScheduleBase.user_id", + "target": 1105, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4027, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2707 + } + ], + "type": { + "name": "str", + "type": "reference" + }, + "inheritedFrom": { + "name": "ScheduleBase.name", + "target": 1106, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4028, + "module": "_models", + "name": "cron_expression", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2708 + } + ], + "type": { + "name": "str", + "type": "reference" + }, + "inheritedFrom": { + "name": "ScheduleBase.cron_expression", + "target": 1107, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4029, + "module": "_models", + "name": "timezone", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2709 + } + ], + "type": { + "name": "str", + "type": "reference" + }, + "inheritedFrom": { + "name": "ScheduleBase.timezone", + "target": 1108, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4030, + "module": "_models", + "name": "is_enabled", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2710 + } + ], + "type": { + "name": "bool", + "type": "reference" + }, + "inheritedFrom": { + "name": "ScheduleBase.is_enabled", + "target": 1109, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4031, + "module": "_models", + "name": "is_exclusive", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2711 + } + ], + "type": { + "name": "bool", + "type": "reference" + }, + "inheritedFrom": { + "name": "ScheduleBase.is_exclusive", + "target": 1110, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4032, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2712 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + }, + "inheritedFrom": { + "name": "ScheduleBase.created_at", + "target": 1111, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4033, + "module": "_models", + "name": "modified_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2713 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + }, + "inheritedFrom": { + "name": "ScheduleBase.modified_at", + "target": 1112, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4034, + "module": "_models", + "name": "next_run_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2714 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='nextRunAt', examples=['2019-04-12T07:34:10.202Z'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "ScheduleBase.next_run_at", + "target": 1113, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4035, + "module": "_models", + "name": "last_run_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2715 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='lastRunAt', examples=['2019-04-12T07:33:10.202Z'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "ScheduleBase.last_run_at", + "target": 1114, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1119, + 4032, + 4028, + 1117, + 4025, + 4030, + 4031, + 4035, + 1116, + 4033, + 4027, + 4034, + 4029, + 1118, + 4026 + ], + "title": "Properties" + } + ], + "id": 1115, + "module": "_models", + "name": "Schedule", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2719 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ScheduleBase", + "target": "1102", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1121, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2731 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1122, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2735 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['my-schedule'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1123, + "module": "_models", + "name": "is_enabled", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2736 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='isEnabled', examples=[True])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1124, + "module": "_models", + "name": "is_exclusive", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2737 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='isExclusive', examples=[True])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1125, + "module": "_models", + "name": "cron_expression", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2738 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='cronExpression', examples=['* * * * *'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1126, + "module": "_models", + "name": "timezone", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2739 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['UTC'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1127, + "module": "_models", + "name": "description", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2740 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['Schedule of actor ...'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1128, + "module": "_models", + "name": "title", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2741 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1129, + "module": "_models", + "name": "actions", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2742 + } + ], + "type": { + "name": "( list[Annotated[ScheduleCreateActionRunActor | ScheduleCreateActionRunActorTask, Field(discriminator='type')]] | None )", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "ScheduleCreateActionRunActor", + "target": "1130" + }, + { + "type": "reference", + "name": "ScheduleCreateActionRunActorTask", + "target": "1136" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1129, + 1125, + 1127, + 1123, + 1124, + 1121, + 1122, + 1126, + 1128 + ], + "title": "Properties" + } + ], + "id": 1120, + "module": "_models", + "name": "ScheduleCreate", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2730 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1131, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2750 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1132, + "module": "_models", + "name": "type", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2754 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "RUN_ACTOR" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1133, + "module": "_models", + "name": "actor_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2755 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1134, + "module": "_models", + "name": "run_input", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2756 + } + ], + "type": { + "name": "Annotated[ScheduleActionRunInput | None, Field(alias='runInput')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ScheduleActionRunInput", + "target": "1088" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1135, + "module": "_models", + "name": "run_options", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2757 + } + ], + "type": { + "name": "Annotated[TaskOptions | None, Field(alias='runOptions')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "TaskOptions", + "target": "1215" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1133, + 1131, + 1134, + 1135, + 1132 + ], + "title": "Properties" + } + ], + "id": 1130, + "module": "_models", + "name": "ScheduleCreateActionRunActor", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2749 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1137, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2762 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1138, + "module": "_models", + "name": "type", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2766 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "RUN_ACTOR_TASK" + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1139, + "module": "_models", + "name": "actor_task_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2767 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1140, + "module": "_models", + "name": "input", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2768 + } + ], + "type": { + "name": "dict[str, Any] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1139, + 1140, + 1137, + 1138 + ], + "title": "Properties" + } + ], + "id": 1136, + "module": "_models", + "name": "ScheduleCreateActionRunActorTask", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2761 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1142, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2773 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1143, + "module": "_models", + "name": "message", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2777 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1144, + "module": "_models", + "name": "level", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2778 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1145, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2779 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1145, + 1144, + 1143, + 1142 + ], + "title": "Properties" + } + ], + "id": 1141, + "module": "_models", + "name": "ScheduleInvoked", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2772 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1147, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2784 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1148, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2788 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ScheduleInvoked", + "target": "1141" + } + ], + "target": "2199" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1148, + 1147 + ], + "title": "Properties" + } + ], + "id": 1146, + "module": "_models", + "name": "ScheduleLogResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2783 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1150, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2793 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1151, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2797 + } + ], + "type": { + "name": "Schedule", + "type": "reference", + "target": "1115" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1151, + 1150 + ], + "title": "Properties" + } + ], + "id": 1149, + "module": "_models", + "name": "ScheduleResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2792 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1153, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2802 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "ScheduleBase.model_config", + "target": 1103, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1154, + "module": "_models", + "name": "actions", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2806 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "ScheduleActionShortRunActor", + "target": "1092" + }, + { + "type": "reference", + "name": "ScheduleActionShortRunActorTask", + "target": "1097" + } + ] + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4036, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2705 + } + ], + "type": { + "name": "str", + "type": "reference" + }, + "inheritedFrom": { + "name": "ScheduleBase.id", + "target": 1104, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4037, + "module": "_models", + "name": "user_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2706 + } + ], + "type": { + "name": "str", + "type": "reference" + }, + "inheritedFrom": { + "name": "ScheduleBase.user_id", + "target": 1105, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4038, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2707 + } + ], + "type": { + "name": "str", + "type": "reference" + }, + "inheritedFrom": { + "name": "ScheduleBase.name", + "target": 1106, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4039, + "module": "_models", + "name": "cron_expression", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2708 + } + ], + "type": { + "name": "str", + "type": "reference" + }, + "inheritedFrom": { + "name": "ScheduleBase.cron_expression", + "target": 1107, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4040, + "module": "_models", + "name": "timezone", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2709 + } + ], + "type": { + "name": "str", + "type": "reference" + }, + "inheritedFrom": { + "name": "ScheduleBase.timezone", + "target": 1108, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4041, + "module": "_models", + "name": "is_enabled", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2710 + } + ], + "type": { + "name": "bool", + "type": "reference" + }, + "inheritedFrom": { + "name": "ScheduleBase.is_enabled", + "target": 1109, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4042, + "module": "_models", + "name": "is_exclusive", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2711 + } + ], + "type": { + "name": "bool", + "type": "reference" + }, + "inheritedFrom": { + "name": "ScheduleBase.is_exclusive", + "target": 1110, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4043, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2712 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + }, + "inheritedFrom": { + "name": "ScheduleBase.created_at", + "target": 1111, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4044, + "module": "_models", + "name": "modified_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2713 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + }, + "inheritedFrom": { + "name": "ScheduleBase.modified_at", + "target": 1112, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4045, + "module": "_models", + "name": "next_run_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2714 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='nextRunAt', examples=['2019-04-12T07:34:10.202Z'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "ScheduleBase.next_run_at", + "target": 1113, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4046, + "module": "_models", + "name": "last_run_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2715 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='lastRunAt', examples=['2019-04-12T07:33:10.202Z'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "ScheduleBase.last_run_at", + "target": 1114, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1154, + 4043, + 4039, + 4036, + 4041, + 4042, + 4046, + 1153, + 4044, + 4038, + 4045, + 4040, + 4037 + ], + "title": "Properties" + } + ], + "id": 1152, + "module": "_models", + "name": "ScheduleShort", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2801 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ScheduleBase", + "target": "1102", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1156, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2811 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of invalid items in the received array of items." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1157, + "module": "_models", + "name": "invalid_items", + "parsedDocstring": { + "text": "A list of invalid items in the received array of items." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2815 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "InvalidItem", + "target": "591" + } + ], + "target": "2199" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1157, + 1156 + ], + "title": "Properties" + } + ], + "id": 1155, + "module": "_models", + "name": "SchemaValidationErrorData", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2810 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1159, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2823 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1160, + "module": "_models", + "name": "format", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2827 + } + ], + "type": { + "name": "SourceCodeFileFormat | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "SourceCodeFileFormat", + "target": "1800" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1161, + "module": "_models", + "name": "content", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2828 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=[\"console.log('This is the main.js file');\"])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1162, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2829 + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1161, + 1160, + 1159, + 1162 + ], + "title": "Properties" + } + ], + "id": 1158, + "module": "_models", + "name": "SourceCodeFile", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2822 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1164, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2839 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The folder path relative to the Actor's root directory." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1165, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "The folder path relative to the Actor's root directory." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2843 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Always `true` for folders. Used to distinguish folders from files." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1166, + "module": "_models", + "name": "folder", + "parsedDocstring": { + "text": "Always `true` for folders. Used to distinguish folders from files." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2847 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Represents a folder in the Actor's source code structure. Distinguished from\nSourceCodeFile by the presence of the `folder` property set to `true`." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1166, + 1164, + 1165 + ], + "title": "Properties" + } + ], + "id": 1163, + "module": "_models", + "name": "SourceCodeFolder", + "parsedDocstring": { + "text": "Represents a folder in the Actor's source code structure. Distinguished from\nSourceCodeFile by the presence of the `folder` property set to `true`." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2833 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1168, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2857 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Aliased dataset IDs for this run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1169, + "module": "_models", + "name": "datasets", + "parsedDocstring": { + "text": "Aliased dataset IDs for this run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2861 + } + ], + "type": { + "name": "Datasets | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Datasets", + "target": "488" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Aliased key-value store IDs for this run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1170, + "module": "_models", + "name": "key_value_stores", + "parsedDocstring": { + "text": "Aliased key-value store IDs for this run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2865 + } + ], + "type": { + "name": "Annotated[KeyValueStores | None, Field(alias='keyValueStores')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "KeyValueStores", + "target": "626" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Aliased request queue IDs for this run." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1171, + "module": "_models", + "name": "request_queues", + "parsedDocstring": { + "text": "Aliased request queue IDs for this run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2869 + } + ], + "type": { + "name": "Annotated[RequestQueues | None, Field(alias='requestQueues')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestQueues", + "target": "945" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A map of aliased storage IDs associated with this run, grouped by storage type." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1169, + 1170, + 1168, + 1171 + ], + "title": "Properties" + } + ], + "id": 1167, + "module": "_models", + "name": "StorageIds", + "parsedDocstring": { + "text": "A map of aliased storage IDs associated with this run, grouped by storage type." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2854 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1173, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2877 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Defines the schema of items in your dataset, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema)" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1174, + "module": "_models", + "name": "dataset", + "parsedDocstring": { + "text": "Defines the schema of items in your dataset, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema)" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2881 + } + ], + "type": { + "name": "dict[str, Any] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1174, + 1173 + ], + "title": "Properties" + } + ], + "id": 1172, + "module": "_models", + "name": "Storages", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2876 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1176, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2889 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1177, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2893 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1178, + "module": "_models", + "name": "title", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2894 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1179, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2895 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1180, + "module": "_models", + "name": "username", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2896 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1181, + "module": "_models", + "name": "user_full_name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2897 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1182, + "module": "_models", + "name": "description", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2898 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1183, + "module": "_models", + "name": "categories", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2899 + } + ], + "type": { + "name": "Annotated[list[str] | None, Field(examples=[['MARKETING', 'LEAD_GENERATION']])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1184, + "module": "_models", + "name": "notice", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2900 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1185, + "module": "_models", + "name": "picture_url", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2901 + } + ], + "type": { + "name": "Annotated[AnyUrl | None, Field(alias='pictureUrl', examples=['https://...'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AnyUrl" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1186, + "module": "_models", + "name": "user_picture_url", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2902 + } + ], + "type": { + "name": "Annotated[AnyUrl | None, Field(alias='userPictureUrl', examples=['https://...'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AnyUrl" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1187, + "module": "_models", + "name": "url", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2903 + } + ], + "type": { + "name": "Annotated[AnyUrl | None, Field(examples=['https://...'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AnyUrl" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1188, + "module": "_models", + "name": "stats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2904 + } + ], + "type": { + "name": "ActorStats", + "type": "reference", + "target": "265" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1189, + "module": "_models", + "name": "current_pricing_info", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2905 + } + ], + "type": { + "name": "CurrentPricingInfo", + "type": "reference", + "target": "424" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Actor is whitelisted for agentic payment processing." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1190, + "module": "_models", + "name": "is_white_listed_for_agentic_payment", + "parsedDocstring": { + "text": "Whether the Actor is whitelisted for agentic payment processing." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2906 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='isWhiteListedForAgenticPayment')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A brief, LLM-generated readme summary" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1191, + "module": "_models", + "name": "readme_summary", + "parsedDocstring": { + "text": "A brief, LLM-generated readme summary" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2910 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='readmeSummary')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1183, + 1189, + 1182, + 1177, + 1190, + 1176, + 1179, + 1184, + 1185, + 1191, + 1188, + 1178, + 1187, + 1181, + 1186, + 1180 + ], + "title": "Properties" + } + ], + "id": 1175, + "module": "_models", + "name": "StoreListActor", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2888 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1193, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2920 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the build associated with this tag." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1194, + "module": "_models", + "name": "build_id", + "parsedDocstring": { + "text": "The ID of the build associated with this tag." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2924 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='buildId', examples=['z2EryhbfhgSyqj6Hn'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The build number/version string." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1195, + "module": "_models", + "name": "build_number", + "parsedDocstring": { + "text": "The build number/version string." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2928 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='buildNumber', examples=['0.0.2'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timestamp when the build finished." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1196, + "module": "_models", + "name": "finished_at", + "parsedDocstring": { + "text": "The timestamp when the build finished." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2932 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='finishedAt', examples=['2019-06-10T11:15:49.286Z'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Information about a tagged build." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1194, + 1195, + 1196, + 1193 + ], + "title": "Properties" + } + ], + "id": 1192, + "module": "_models", + "name": "TaggedBuildInfo", + "parsedDocstring": { + "text": "Information about a tagged build." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2917 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1198, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2942 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1199, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2946 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1200, + "module": "_models", + "name": "user_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2947 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1201, + "module": "_models", + "name": "act_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2948 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1202, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2949 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1203, + "module": "_models", + "name": "username", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2950 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['janedoe'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1204, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2951 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1205, + "module": "_models", + "name": "modified_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2952 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1206, + "module": "_models", + "name": "removed_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2953 + } + ], + "type": { + "name": "Annotated[AwareDatetime | None, Field(alias='removedAt')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AwareDatetime" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1207, + "module": "_models", + "name": "stats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2954 + } + ], + "type": { + "name": "TaskStats | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "TaskStats", + "target": "1238" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1208, + "module": "_models", + "name": "options", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2955 + } + ], + "type": { + "name": "TaskOptions | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "TaskOptions", + "target": "1215" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1209, + "module": "_models", + "name": "input", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2956 + } + ], + "type": { + "name": "TaskInput | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "TaskInput", + "target": "1213" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1210, + "module": "_models", + "name": "title", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2957 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1211, + "module": "_models", + "name": "actor_standby", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2958 + } + ], + "type": { + "name": "Annotated[ActorStandby | None, Field(alias='actorStandby')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorStandby", + "target": "255" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1212, + "module": "_models", + "name": "standby_url", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2959 + } + ], + "type": { + "name": "Annotated[AnyUrl | None, Field(alias='standbyUrl')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AnyUrl" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1201, + 1211, + 1204, + 1199, + 1209, + 1198, + 1205, + 1202, + 1208, + 1206, + 1212, + 1207, + 1210, + 1200, + 1203 + ], + "title": "Properties" + } + ], + "id": 1197, + "module": "_models", + "name": "Task", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2941 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1214, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2969 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The input configuration for the Actor task. This is a user-defined JSON object\nthat will be passed to the Actor when the task is run." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1214 + ], + "title": "Properties" + } + ], + "id": 1213, + "module": "_models", + "name": "TaskInput", + "parsedDocstring": { + "text": "The input configuration for the Actor task. This is a user-defined JSON object\nthat will be passed to the Actor when the task is run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2963 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1216, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2977 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1217, + "module": "_models", + "name": "build", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2981 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['latest'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1218, + "module": "_models", + "name": "timeout_secs", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2982 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='timeoutSecs', examples=[300])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1219, + "module": "_models", + "name": "memory_mbytes", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2983 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='memoryMbytes', examples=[1024])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1220, + "module": "_models", + "name": "max_items", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2984 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='maxItems', examples=[1000])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1221, + "module": "_models", + "name": "max_total_charge_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2985 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='maxTotalChargeUsd', examples=[5])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1222, + "module": "_models", + "name": "restart_on_error", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2986 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='restartOnError', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1217, + 1220, + 1221, + 1219, + 1216, + 1222, + 1218 + ], + "title": "Properties" + } + ], + "id": 1215, + "module": "_models", + "name": "TaskOptions", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2976 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1224, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2993 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1225, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2997 + } + ], + "type": { + "name": "Task", + "type": "reference", + "target": "1197" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response containing Actor task data." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1225, + 1224 + ], + "title": "Properties" + } + ], + "id": 1223, + "module": "_models", + "name": "TaskResponse", + "parsedDocstring": { + "text": "Response containing Actor task data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 2990 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1227, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3002 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1228, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3006 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1229, + "module": "_models", + "name": "user_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3007 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1230, + "module": "_models", + "name": "act_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3008 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1231, + "module": "_models", + "name": "act_name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3009 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='actName', examples=['my-actor'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1232, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3010 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1233, + "module": "_models", + "name": "username", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3011 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['janedoe'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1234, + "module": "_models", + "name": "act_username", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3012 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='actUsername', examples=['janedoe'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1235, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3013 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1236, + "module": "_models", + "name": "modified_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3014 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1237, + "module": "_models", + "name": "stats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3015 + } + ], + "type": { + "name": "TaskStats | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "TaskStats", + "target": "1238" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1230, + 1231, + 1234, + 1235, + 1228, + 1227, + 1236, + 1232, + 1237, + 1229, + 1233 + ], + "title": "Properties" + } + ], + "id": 1226, + "module": "_models", + "name": "TaskShort", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3001 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1239, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3020 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1240, + "module": "_models", + "name": "total_runs", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3024 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='totalRuns', examples=[15])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1239, + 1240 + ], + "title": "Properties" + } + ], + "id": 1238, + "module": "_models", + "name": "TaskStats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3019 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1242, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3029 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1243, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3033 + } + ], + "type": { + "name": "WebhookDispatch", + "type": "reference", + "target": "1386" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1243, + 1242 + ], + "title": "Properties" + } + ], + "id": 1241, + "module": "_models", + "name": "TestWebhookResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3028 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "WebhookDispatchResponse", + "target": "1396", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1245, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3038 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1246, + "module": "_models", + "name": "error", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3042 + } + ], + "type": { + "name": "UnknownBuildTagErrorDetail | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "UnknownBuildTagErrorDetail", + "target": "1247" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1246, + 1245 + ], + "title": "Properties" + } + ], + "id": 1244, + "module": "_models", + "name": "UnknownBuildTagError", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3037 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1248, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3047 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "overwrites": { + "name": "ErrorDetail.model_config", + "target": 552, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Machine-processable error type identifier." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1249, + "module": "_models", + "name": "type", + "parsedDocstring": { + "text": "Machine-processable error type identifier." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3051 + } + ], + "type": { + "name": "Literal", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "unknown-build-tag" + } + ] + }, + "overwrites": { + "name": "ErrorDetail.type", + "target": 553, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Human-readable error message describing what went wrong." + } + ] + }, + "flags": {}, + "groups": [], + "id": 4049, + "module": "_models", + "name": "message", + "parsedDocstring": { + "text": "Human-readable error message describing what went wrong." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1007 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ErrorDetail.message", + "target": 554, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4049, + 1248, + 1249 + ], + "title": "Properties" + } + ], + "id": 1247, + "module": "_models", + "name": "UnknownBuildTagErrorDetail", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3046 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ErrorDetail", + "target": "551", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1251, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3061 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1252, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3065 + } + ], + "type": { + "name": "UnlockRequestsResult", + "type": "reference", + "target": "1253" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response containing the result of unlocking requests." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1252, + 1251 + ], + "title": "Properties" + } + ], + "id": 1250, + "module": "_models", + "name": "UnlockRequestsResponse", + "parsedDocstring": { + "text": "Response containing the result of unlocking requests." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3058 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1254, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3072 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of requests that were successfully unlocked." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1255, + "module": "_models", + "name": "unlocked_count", + "parsedDocstring": { + "text": "Number of requests that were successfully unlocked." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3076 + } + ], + "type": { + "name": "int", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Result of unlocking requests in the request queue." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1254, + 1255 + ], + "title": "Properties" + } + ], + "id": 1253, + "module": "_models", + "name": "UnlockRequestsResult", + "parsedDocstring": { + "text": "Result of unlocking requests in the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3069 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1257, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3084 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1258, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3088 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['MyActor'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1259, + "module": "_models", + "name": "description", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3089 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['My favourite actor!'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1260, + "module": "_models", + "name": "is_public", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3090 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='isPublic', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1261, + "module": "_models", + "name": "actor_permission_level", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3091 + } + ], + "type": { + "name": "Annotated[ActorPermissionLevel | None, Field(alias='actorPermissionLevel')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorPermissionLevel", + "target": "1795" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1262, + "module": "_models", + "name": "seo_title", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3092 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='seoTitle', examples=['My actor'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1263, + "module": "_models", + "name": "seo_description", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3093 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='seoDescription', examples=['My actor is the best'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1264, + "module": "_models", + "name": "title", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3094 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['My Actor'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1265, + "module": "_models", + "name": "restart_on_error", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3095 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='restartOnError', deprecated=True, examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1266, + "module": "_models", + "name": "versions", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3096 + } + ], + "type": { + "name": "list[CreateOrUpdateVersionRequest] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "CreateOrUpdateVersionRequest", + "target": "393" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1267, + "module": "_models", + "name": "pricing_infos", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3097 + } + ], + "type": { + "name": "Annotated[ list[ Annotated[ PayPerEventActorPricingInfo | PricePerDatasetItemActorPricingInfo | FlatPricePerMonthActorPricingInfo | FreeActorPricingInfo, Field(discriminator='pricing_model'), ] ] | None, Field(alias='pricingInfos'), ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "PayPerEventActorPricingInfo", + "target": "786" + }, + { + "type": "reference", + "name": "PricePerDatasetItemActorPricingInfo", + "target": "813" + } + ] + }, + { + "type": "reference", + "name": "FlatPricePerMonthActorPricingInfo", + "target": "570" + } + ] + }, + { + "type": "reference", + "name": "FreeActorPricingInfo", + "target": "575" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1268, + "module": "_models", + "name": "categories", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3110 + } + ], + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1269, + "module": "_models", + "name": "default_run_options", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3111 + } + ], + "type": { + "name": "Annotated[DefaultRunOptions | None, Field(alias='defaultRunOptions')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "DefaultRunOptions", + "target": "499" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object to modify tags on the Actor's builds. The key is the tag name (e.g., _latest_), and the value is either an object with a `buildId` or `null`.\n\nThis operation is a patch; any existing tags that you omit from this object will be preserved.\n\n- **To create or reassign a tag**, provide the tag name with a `buildId`. e.g., to assign the _latest_ tag:\n\n \n\n ```json\n {\n \"latest\": {\n \"buildId\": \"z2EryhbfhgSyqj6Hn\"\n }\n }\n ```\n\n\n- **To remove a tag**, provide the tag name with a `null` value. e.g., to remove the _beta_ tag:\n\n \n\n ```json\n {\n \"beta\": null\n }\n ```\n\n\n- **To perform multiple operations**, combine them. The following reassigns _latest_ and removes _beta_, while preserving any other existing tags.\n\n \n\n ```json\n {\n \"latest\": {\n \"buildId\": \"z2EryhbfhgSyqj6Hn\"\n },\n \"beta\": null\n }\n ```" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1270, + "module": "_models", + "name": "tagged_builds", + "parsedDocstring": { + "text": "An object to modify tags on the Actor's builds. The key is the tag name (e.g., _latest_), and the value is either an object with a `buildId` or `null`.\n\nThis operation is a patch; any existing tags that you omit from this object will be preserved.\n\n- **To create or reassign a tag**, provide the tag name with a `buildId`. e.g., to assign the _latest_ tag:\n\n \n\n ```json\n {\n \"latest\": {\n \"buildId\": \"z2EryhbfhgSyqj6Hn\"\n }\n }\n ```\n\n\n- **To remove a tag**, provide the tag name with a `null` value. e.g., to remove the _beta_ tag:\n\n \n\n ```json\n {\n \"beta\": null\n }\n ```\n\n\n- **To perform multiple operations**, combine them. The following reassigns _latest_ and removes _beta_, while preserving any other existing tags.\n\n \n\n ```json\n {\n \"latest\": {\n \"buildId\": \"z2EryhbfhgSyqj6Hn\"\n },\n \"beta\": null\n }\n ```" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3112 + } + ], + "type": { + "name": "Annotated[ dict[str, Any] | None, Field(alias='taggedBuilds', examples=[{'latest': {'buildId': 'z2EryhbfhgSyqj6Hn'}, 'beta': None}]), ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1271, + "module": "_models", + "name": "actor_standby", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3157 + } + ], + "type": { + "name": "Annotated[ActorStandby | None, Field(alias='actorStandby')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorStandby", + "target": "255" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1272, + "module": "_models", + "name": "example_run_input", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3158 + } + ], + "type": { + "name": "Annotated[ExampleRunInput | None, Field(alias='exampleRunInput')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ExampleRunInput", + "target": "562" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1273, + "module": "_models", + "name": "is_deprecated", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3159 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='isDeprecated')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1261, + 1271, + 1268, + 1269, + 1259, + 1272, + 1273, + 1260, + 1257, + 1258, + 1267, + 1265, + 1263, + 1262, + 1270, + 1264, + 1266 + ], + "title": "Properties" + } + ], + "id": 1256, + "module": "_models", + "name": "UpdateActorRequest", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3083 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1275, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3164 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1276, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3168 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1277, + "module": "_models", + "name": "general_access", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3169 + } + ], + "type": { + "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "GeneralAccess", + "target": "1797" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1277, + 1275, + 1276 + ], + "title": "Properties" + } + ], + "id": 1274, + "module": "_models", + "name": "UpdateDatasetRequest", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3163 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "UpdateStoreRequest", + "target": "1295", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1279, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3174 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "If your platform usage in the billing period exceeds the prepaid usage, you will be charged extra. Setting this property you can update your hard limit on monthly platform usage to prevent accidental overage or to limit the extra charges." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1280, + "module": "_models", + "name": "max_monthly_usage_usd", + "parsedDocstring": { + "text": "If your platform usage in the billing period exceeds the prepaid usage, you will be charged extra. Setting this property you can update your hard limit on monthly platform usage to prevent accidental overage or to limit the extra charges." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3178 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='maxMonthlyUsageUsd', examples=[300])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Apify securely stores your ten most recent Actor runs indefinitely, ensuring they are always accessible. Unnamed storages and other Actor runs are automatically deleted after the retention period. If you're subscribed, you can change it to keep data for longer or to limit your usage. [Lear more](https://docs.apify.com/platform/storage/usage#data-retention)." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1281, + "module": "_models", + "name": "data_retention_days", + "parsedDocstring": { + "text": "Apify securely stores your ten most recent Actor runs indefinitely, ensuring they are always accessible. Unnamed storages and other Actor runs are automatically deleted after the retention period. If you're subscribed, you can change it to keep data for longer or to limit your usage. [Lear more](https://docs.apify.com/platform/storage/usage#data-retention)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3183 + } + ], + "type": { + "name": "Annotated[int | None, Field(alias='dataRetentionDays', examples=[90])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1281, + 1280, + 1279 + ], + "title": "Properties" + } + ], + "id": 1278, + "module": "_models", + "name": "UpdateLimitsRequest", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3173 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1283, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3194 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new name for the request queue." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1284, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "The new name for the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3198 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1285, + "module": "_models", + "name": "general_access", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3202 + } + ], + "type": { + "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "GeneralAccess", + "target": "1797" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Request object for updating a request queue." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1285, + 1283, + 1284 + ], + "title": "Properties" + } + ], + "id": 1282, + "module": "_models", + "name": "UpdateRequestQueueRequest", + "parsedDocstring": { + "text": "Request object for updating a request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3191 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1287, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3209 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1288, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3213 + } + ], + "type": { + "name": "RequestRegistration", + "type": "reference", + "target": "948" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response containing the result of updating a request in the request queue." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1288, + 1287 + ], + "title": "Properties" + } + ], + "id": 1286, + "module": "_models", + "name": "UpdateRequestResponse", + "parsedDocstring": { + "text": "Response containing the result of updating a request in the request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3206 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1290, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3218 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1291, + "module": "_models", + "name": "run_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3222 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='runId', examples=['3KH8gEpp4d8uQSe8T'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1292, + "module": "_models", + "name": "status_message", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3223 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='statusMessage', examples=['Actor has finished'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1293, + "module": "_models", + "name": "is_status_message_terminal", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3224 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='isStatusMessageTerminal', examples=[True])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1294, + "module": "_models", + "name": "general_access", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3225 + } + ], + "type": { + "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "GeneralAccess", + "target": "1797" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1294, + 1293, + 1290, + 1291, + 1292 + ], + "title": "Properties" + } + ], + "id": 1289, + "module": "_models", + "name": "UpdateRunRequest", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3217 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4022, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3164 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "inheritedFrom": { + "name": "UpdateDatasetRequest.model_config", + "target": 1275, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4023, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3168 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "UpdateDatasetRequest.name", + "target": 1276, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4024, + "module": "_models", + "name": "general_access", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3169 + } + ], + "type": { + "name": "Annotated[GeneralAccess | None, Field(alias='generalAccess')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "GeneralAccess", + "target": "1797" + }, + { + "type": "literal", + "value": null + } + ] + }, + "inheritedFrom": { + "name": "UpdateDatasetRequest.general_access", + "target": 1277, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4024, + 4022, + 4023 + ], + "title": "Properties" + } + ], + "id": 1295, + "module": "_models", + "name": "UpdateStoreRequest", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3229 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "UpdateDatasetRequest", + "target": "1274", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1297, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3235 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1298, + "module": "_models", + "name": "name", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3239 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['my-task'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1299, + "module": "_models", + "name": "options", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3240 + } + ], + "type": { + "name": "TaskOptions | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "TaskOptions", + "target": "1215" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1300, + "module": "_models", + "name": "input", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3241 + } + ], + "type": { + "name": "TaskInput | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "TaskInput", + "target": "1213" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1301, + "module": "_models", + "name": "title", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3242 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1302, + "module": "_models", + "name": "actor_standby", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3243 + } + ], + "type": { + "name": "Annotated[ActorStandby | None, Field(alias='actorStandby')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorStandby", + "target": "255" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1302, + 1300, + 1297, + 1298, + 1299, + 1301 + ], + "title": "Properties" + } + ], + "id": 1296, + "module": "_models", + "name": "UpdateTaskRequest", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3234 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1304, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3248 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1305, + "module": "_models", + "name": "start_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3252 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1306, + "module": "_models", + "name": "end_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3253 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1306, + 1304, + 1305 + ], + "title": "Properties" + } + ], + "id": 1303, + "module": "_models", + "name": "UsageCycle", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3247 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1308, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3258 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1309, + "module": "_models", + "name": "quantity", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3262 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1310, + "module": "_models", + "name": "base_amount_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3263 + } + ], + "type": { + "name": "float", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1311, + "module": "_models", + "name": "base_unit_price_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3264 + } + ], + "type": { + "name": "Annotated[float | None, Field(alias='baseUnitPriceUsd', examples=[0.25])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1312, + "module": "_models", + "name": "amount_after_volume_discount_usd", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3265 + } + ], + "type": { + "name": "Annotated[ float | None, Field(alias='amountAfterVolumeDiscountUsd', examples=[0.69611875]) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1313, + "module": "_models", + "name": "price_tiers", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3268 + } + ], + "type": { + "name": "Annotated[list[PriceTiers] | None, Field(alias='priceTiers')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "PriceTiers", + "target": "818" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1312, + 1310, + 1311, + 1308, + 1313, + 1309 + ], + "title": "Properties" + } + ], + "id": 1307, + "module": "_models", + "name": "UsageItem", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3257 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1315, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3273 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1316, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3277 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1317, + "module": "_models", + "name": "username", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3278 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1318, + "module": "_models", + "name": "profile", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3279 + } + ], + "type": { + "name": "Profile", + "type": "reference", + "target": "831" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1319, + "module": "_models", + "name": "email", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3280 + } + ], + "type": { + "name": "EmailStr", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1320, + "module": "_models", + "name": "proxy", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3281 + } + ], + "type": { + "name": "Proxy", + "type": "reference", + "target": "842" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1321, + "module": "_models", + "name": "plan", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3282 + } + ], + "type": { + "name": "Plan", + "type": "reference", + "target": "791" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1322, + "module": "_models", + "name": "effective_platform_features", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3283 + } + ], + "type": { + "name": "EffectivePlatformFeatures", + "type": "reference", + "target": "522" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1323, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3284 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1324, + "module": "_models", + "name": "is_paying", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3285 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1323, + 1322, + 1319, + 1316, + 1324, + 1315, + 1321, + 1318, + 1320, + 1317 + ], + "title": "Properties" + } + ], + "id": 1314, + "module": "_models", + "name": "UserPrivateInfo", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3272 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1326, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3290 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1327, + "module": "_models", + "name": "username", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3294 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1328, + "module": "_models", + "name": "profile", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3295 + } + ], + "type": { + "name": "Profile | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Profile", + "target": "831" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1326, + 1328, + 1327 + ], + "title": "Properties" + } + ], + "id": 1325, + "module": "_models", + "name": "UserPublicInfo", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3289 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1330, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3300 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The path to the instance being validated." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1331, + "module": "_models", + "name": "instance_path", + "parsedDocstring": { + "text": "The path to the instance being validated." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3304 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='instancePath')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The path to the schema that failed the validation." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1332, + "module": "_models", + "name": "schema_path", + "parsedDocstring": { + "text": "The path to the schema that failed the validation." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3308 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='schemaPath')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The validation keyword that caused the error." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1333, + "module": "_models", + "name": "keyword", + "parsedDocstring": { + "text": "The validation keyword that caused the error." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3312 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A message describing the validation error." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1334, + "module": "_models", + "name": "message", + "parsedDocstring": { + "text": "A message describing the validation error." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3316 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Additional parameters specific to the validation error." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1335, + "module": "_models", + "name": "params", + "parsedDocstring": { + "text": "Additional parameters specific to the validation error." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3320 + } + ], + "type": { + "name": "dict[str, Any] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1331, + 1333, + 1334, + 1330, + 1335, + 1332 + ], + "title": "Properties" + } + ], + "id": 1329, + "module": "_models", + "name": "ValidationError", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3299 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1337, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3328 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1338, + "module": "_models", + "name": "version_number", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3332 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1339, + "module": "_models", + "name": "source_type", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3333 + } + ], + "type": { + "name": "Annotated[VersionSourceType | None, Field(alias='sourceType')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "VersionSourceType", + "target": "1802" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1340, + "module": "_models", + "name": "env_vars", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3334 + } + ], + "type": { + "name": "Annotated[list[EnvVar] | None, Field(alias='envVars')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "EnvVar", + "target": "541" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1341, + "module": "_models", + "name": "apply_env_vars_to_build", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3335 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='applyEnvVarsToBuild', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1342, + "module": "_models", + "name": "build_tag", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3336 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='buildTag', examples=['latest'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1343, + "module": "_models", + "name": "source_files", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3337 + } + ], + "type": { + "name": "Annotated[ list[SourceCodeFile | SourceCodeFolder] | None, Field(alias='sourceFiles', title='VersionSourceFiles') ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "SourceCodeFile", + "target": "1158" + }, + { + "type": "reference", + "name": "SourceCodeFolder", + "target": "1163" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "URL of the Git repository when sourceType is GIT_REPO." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1344, + "module": "_models", + "name": "git_repo_url", + "parsedDocstring": { + "text": "URL of the Git repository when sourceType is GIT_REPO." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3340 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='gitRepoUrl')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "URL of the tarball when sourceType is TARBALL." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1345, + "module": "_models", + "name": "tarball_url", + "parsedDocstring": { + "text": "URL of the tarball when sourceType is TARBALL." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3344 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='tarballUrl')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "URL of the GitHub Gist when sourceType is GITHUB_GIST." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1346, + "module": "_models", + "name": "github_gist_url", + "parsedDocstring": { + "text": "URL of the GitHub Gist when sourceType is GITHUB_GIST." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3348 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='gitHubGistUrl')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1341, + 1342, + 1340, + 1344, + 1346, + 1337, + 1343, + 1339, + 1345, + 1338 + ], + "title": "Properties" + } + ], + "id": 1336, + "module": "_models", + "name": "Version", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3327 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1348, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3356 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1349, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3360 + } + ], + "type": { + "name": "Version", + "type": "reference", + "target": "1336" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1349, + 1348 + ], + "title": "Properties" + } + ], + "id": 1347, + "module": "_models", + "name": "VersionResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3355 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1351, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3365 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1352, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3369 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1353, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3370 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1354, + "module": "_models", + "name": "modified_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3371 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1355, + "module": "_models", + "name": "user_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3372 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1356, + "module": "_models", + "name": "is_ad_hoc", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3373 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='isAdHoc', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1357, + "module": "_models", + "name": "should_interpolate_strings", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3374 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='shouldInterpolateStrings', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1358, + "module": "_models", + "name": "event_types", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3375 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookEventType", + "target": "1804" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1359, + "module": "_models", + "name": "condition", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3376 + } + ], + "type": { + "name": "WebhookCondition", + "type": "reference", + "target": "1368" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1360, + "module": "_models", + "name": "ignore_ssl_errors", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3377 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1361, + "module": "_models", + "name": "do_not_retry", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3378 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='doNotRetry', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1362, + "module": "_models", + "name": "request_url", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3379 + } + ], + "type": { + "name": "AnyUrl", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1363, + "module": "_models", + "name": "payload_template", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3380 + } + ], + "type": { + "name": "Annotated[ str | None, Field(alias='payloadTemplate', examples=['{\\\\n \"userId\": {{userId}}...']) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1364, + "module": "_models", + "name": "headers_template", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3383 + } + ], + "type": { + "name": "Annotated[ str | None, Field(alias='headersTemplate', examples=['{\\\\n \"Authorization\": \"Bearer ...\"}']) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1365, + "module": "_models", + "name": "description", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3386 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['this is webhook description'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1366, + "module": "_models", + "name": "last_dispatch", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3387 + } + ], + "type": { + "name": "Annotated[ExampleWebhookDispatch | None, Field(alias='lastDispatch')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ExampleWebhookDispatch", + "target": "566" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1367, + "module": "_models", + "name": "stats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3388 + } + ], + "type": { + "name": "WebhookStats | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "WebhookStats", + "target": "1421" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1359, + 1353, + 1365, + 1361, + 1358, + 1364, + 1352, + 1360, + 1356, + 1366, + 1351, + 1354, + 1363, + 1362, + 1357, + 1367, + 1355 + ], + "title": "Properties" + } + ], + "id": 1350, + "module": "_models", + "name": "Webhook", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3364 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1369, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3393 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1370, + "module": "_models", + "name": "actor_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3397 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='actorId', examples=['hksJZtadYvn4mBuin'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1371, + "module": "_models", + "name": "actor_task_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3398 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='actorTaskId', examples=['asdLZtadYvn4mBZmm'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1372, + "module": "_models", + "name": "actor_run_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3399 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='actorRunId', examples=['hgdKZtadYvn4mBpoi'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1370, + 1372, + 1371, + 1369 + ], + "title": "Properties" + } + ], + "id": 1368, + "module": "_models", + "name": "WebhookCondition", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3392 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1374, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3404 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1375, + "module": "_models", + "name": "is_ad_hoc", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3408 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='isAdHoc', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1376, + "module": "_models", + "name": "event_types", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3409 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookEventType", + "target": "1804" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1377, + "module": "_models", + "name": "condition", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3410 + } + ], + "type": { + "name": "WebhookCondition", + "type": "reference", + "target": "1368" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1378, + "module": "_models", + "name": "idempotency_key", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3411 + } + ], + "type": { + "name": "Annotated[str | None, Field(alias='idempotencyKey', examples=['fdSJmdP3nfs7sfk3y'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1379, + "module": "_models", + "name": "ignore_ssl_errors", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3412 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='ignoreSslErrors', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1380, + "module": "_models", + "name": "do_not_retry", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3413 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='doNotRetry', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1381, + "module": "_models", + "name": "request_url", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3414 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1382, + "module": "_models", + "name": "payload_template", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3415 + } + ], + "type": { + "name": "Annotated[ str | None, Field(alias='payloadTemplate', examples=['{\\\\n \"userId\": {{userId}}...']) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1383, + "module": "_models", + "name": "headers_template", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3418 + } + ], + "type": { + "name": "Annotated[ str | None, Field(alias='headersTemplate', examples=['{\\\\n \"Authorization\": \"Bearer ...\"}']) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1384, + "module": "_models", + "name": "description", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3421 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['this is webhook description'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1385, + "module": "_models", + "name": "should_interpolate_strings", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3422 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='shouldInterpolateStrings', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1377, + 1384, + 1380, + 1376, + 1383, + 1378, + 1379, + 1375, + 1374, + 1382, + 1381, + 1385 + ], + "title": "Properties" + } + ], + "id": 1373, + "module": "_models", + "name": "WebhookCreate", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3403 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1387, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3427 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1388, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3431 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1389, + "module": "_models", + "name": "user_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3432 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1390, + "module": "_models", + "name": "webhook_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3433 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1391, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3434 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1392, + "module": "_models", + "name": "status", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3435 + } + ], + "type": { + "name": "WebhookDispatchStatus", + "type": "reference", + "target": "1803" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1393, + "module": "_models", + "name": "event_type", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3436 + } + ], + "type": { + "name": "WebhookEventType", + "type": "reference", + "target": "1804" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1394, + "module": "_models", + "name": "event_data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3437 + } + ], + "type": { + "name": "Annotated[EventData | None, Field(alias='eventData', title='eventData')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "EventData", + "target": "558" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1395, + "module": "_models", + "name": "calls", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3438 + } + ], + "type": { + "name": "Annotated[list[Call] | None, Field(title='calls')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "Call", + "target": "358" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1395, + 1391, + 1394, + 1393, + 1388, + 1387, + 1392, + 1389, + 1390 + ], + "title": "Properties" + } + ], + "id": 1386, + "module": "_models", + "name": "WebhookDispatch", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3426 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4020, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3029 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "inheritedFrom": { + "name": "TestWebhookResponse.model_config", + "target": 1242, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4021, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3033 + } + ], + "type": { + "name": "WebhookDispatch", + "type": "reference", + "target": "1386" + }, + "inheritedFrom": { + "name": "TestWebhookResponse.data", + "target": 1243, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4021, + 4020 + ], + "title": "Properties" + } + ], + "id": 1396, + "module": "_models", + "name": "WebhookDispatchResponse", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3442 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "TestWebhookResponse", + "target": "1241", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1398, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3454 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1399, + "module": "_models", + "name": "event_types", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3458 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookEventType", + "target": "1804" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL to which the webhook sends its payload." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1400, + "module": "_models", + "name": "request_url", + "parsedDocstring": { + "text": "The URL to which the webhook sends its payload." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3459 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional template for the JSON payload sent by the webhook." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1401, + "module": "_models", + "name": "payload_template", + "parsedDocstring": { + "text": "Optional template for the JSON payload sent by the webhook." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3463 + } + ], + "type": { + "name": "Annotated[ str | None, Field(alias='payloadTemplate', examples=['{\\\\n \"userId\": {{userId}}...']) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional template for the HTTP headers sent by the webhook." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1402, + "module": "_models", + "name": "headers_template", + "parsedDocstring": { + "text": "Optional template for the HTTP headers sent by the webhook." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3469 + } + ], + "type": { + "name": "Annotated[ str | None, Field(alias='headersTemplate', examples=['{\\\\n \"Authorization\": \"Bearer ...\"}']) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1399, + 1402, + 1398, + 1401, + 1400 + ], + "title": "Properties" + } + ], + "id": 1397, + "module": "_models", + "name": "WebhookRepresentation", + "parsedDocstring": { + "text": "Minimal representation of an ad-hoc webhook attached to a single Actor run or build via the\n`webhooks` query parameter. The query parameter value is a Base64-encoded JSON array whose\nitems match this schema. Persistent webhook fields (e.g. `condition`) are not used here." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3447 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1404, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3481 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1405, + "module": "_models", + "name": "data", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3485 + } + ], + "type": { + "name": "Webhook", + "type": "reference", + "target": "1350" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response containing webhook data." + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1405, + 1404 + ], + "title": "Properties" + } + ], + "id": 1403, + "module": "_models", + "name": "WebhookResponse", + "parsedDocstring": { + "text": "Response containing webhook data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3478 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1407, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3490 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1408, + "module": "_models", + "name": "id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3494 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1409, + "module": "_models", + "name": "created_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3495 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1410, + "module": "_models", + "name": "modified_at", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3496 + } + ], + "type": { + "name": "AwareDatetime", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1411, + "module": "_models", + "name": "user_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3497 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1412, + "module": "_models", + "name": "is_ad_hoc", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3498 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='isAdHoc', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1413, + "module": "_models", + "name": "should_interpolate_strings", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3499 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='shouldInterpolateStrings', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1414, + "module": "_models", + "name": "event_types", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3500 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookEventType", + "target": "1804" + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1415, + "module": "_models", + "name": "condition", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3501 + } + ], + "type": { + "name": "WebhookCondition", + "type": "reference", + "target": "1368" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1416, + "module": "_models", + "name": "ignore_ssl_errors", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3502 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1417, + "module": "_models", + "name": "do_not_retry", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3503 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1418, + "module": "_models", + "name": "request_url", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3504 + } + ], + "type": { + "name": "AnyUrl", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1419, + "module": "_models", + "name": "last_dispatch", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3505 + } + ], + "type": { + "name": "Annotated[ExampleWebhookDispatch | None, Field(alias='lastDispatch')]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ExampleWebhookDispatch", + "target": "566" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1420, + "module": "_models", + "name": "stats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3506 + } + ], + "type": { + "name": "WebhookStats | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "WebhookStats", + "target": "1421" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1415, + 1409, + 1417, + 1414, + 1408, + 1416, + 1412, + 1419, + 1407, + 1410, + 1418, + 1413, + 1420, + 1411 + ], + "title": "Properties" + } + ], + "id": 1406, + "module": "_models", + "name": "WebhookShort", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3489 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1422, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3511 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1423, + "module": "_models", + "name": "total_dispatches", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3515 + } + ], + "type": { + "name": "int", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1422, + 1423 + ], + "title": "Properties" + } + ], + "id": 1421, + "module": "_models", + "name": "WebhookStats", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3510 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1425, + "module": "_models", + "name": "model_config", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3520 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1426, + "module": "_models", + "name": "is_ad_hoc", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3524 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='isAdHoc', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1427, + "module": "_models", + "name": "event_types", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3525 + } + ], + "type": { + "name": "Annotated[ list[WebhookEventType] | None, Field(alias='eventTypes', examples=[['ACTOR.RUN.SUCCEEDED']]) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookEventType", + "target": "1804" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1428, + "module": "_models", + "name": "condition", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3528 + } + ], + "type": { + "name": "WebhookCondition | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "WebhookCondition", + "target": "1368" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1429, + "module": "_models", + "name": "ignore_ssl_errors", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3529 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='ignoreSslErrors', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1430, + "module": "_models", + "name": "do_not_retry", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3530 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='doNotRetry', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1431, + "module": "_models", + "name": "request_url", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3531 + } + ], + "type": { + "name": "Annotated[AnyUrl | None, Field(alias='requestUrl', examples=['http://example.com/'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AnyUrl" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1432, + "module": "_models", + "name": "payload_template", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3532 + } + ], + "type": { + "name": "Annotated[ str | None, Field(alias='payloadTemplate', examples=['{\\\\n \"userId\": {{userId}}...']) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1433, + "module": "_models", + "name": "headers_template", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3535 + } + ], + "type": { + "name": "Annotated[ str | None, Field(alias='headersTemplate', examples=['{\\\\n \"Authorization\": \"Bearer ...\"}']) ]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1434, + "module": "_models", + "name": "description", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3538 + } + ], + "type": { + "name": "Annotated[str | None, Field(examples=['this is webhook description'])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1435, + "module": "_models", + "name": "should_interpolate_strings", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3539 + } + ], + "type": { + "name": "Annotated[bool | None, Field(alias='shouldInterpolateStrings', examples=[False])]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [ + { + "args": "('Models')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1428, + 1434, + 1430, + 1427, + 1433, + 1429, + 1426, + 1425, + 1432, + 1431, + 1435 + ], + "title": "Properties" + } + ], + "id": 1424, + "module": "_models", + "name": "WebhookUpdate", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_models.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 3519 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the Apify API client.\n\nTo use a custom HTTP client, use the `with_custom_http_client` class method instead.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1437, + "module": "_apify_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the Apify API client.\n\nTo use a custom HTTP client, use the `with_custom_http_client` class method instead.\n", + "args": { + "token": "The Apify API token. You can find your token on the\n[Integrations](https://console.apify.com/account/integrations) page in the Apify Console.", + "api_url": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com. It can\nbe an internal URL that is not globally accessible, in which case `api_public_url` should be set\nas well.", + "api_public_url": "The globally accessible URL of the Apify API server. Should be set only if `api_url`\nis an internal URL that is not globally accessible. Defaults to https://api.apify.com.", + "max_retries": "How many times to retry a failed request at most.", + "min_delay_between_retries": "How long will the client wait between retrying requests\n(increases exponentially from this value).", + "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).", + "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).", + "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).", + "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.", + "headers": "Additional HTTP headers to include in all API requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 112 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the Apify API client.\n\nTo use a custom HTTP client, use the `with_custom_http_client` class method instead.\n" + } + ] + }, + "flags": {}, + "id": 1438, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Apify API token. You can find your token on the\n[Integrations](https://console.apify.com/account/integrations) page in the Apify Console." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 1439, + "kind": 32768, + "kindString": "Parameter", + "name": "token", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com. It can\nbe an internal URL that is not globally accessible, in which case `api_public_url` should be set\nas well." + } + ] + }, + "defaultValue": "DEFAULT_API_URL", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1440, + "kind": 32768, + "kindString": "Parameter", + "name": "api_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The globally accessible URL of the Apify API server. Should be set only if `api_url`\nis an internal URL that is not globally accessible. Defaults to https://api.apify.com." + } + ] + }, + "defaultValue": "DEFAULT_API_URL", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1441, + "kind": 32768, + "kindString": "Parameter", + "name": "api_public_url", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many times to retry a failed request at most." + } + ] + }, + "defaultValue": "DEFAULT_MAX_RETRIES", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1442, + "kind": 32768, + "kindString": "Parameter", + "name": "max_retries", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How long will the client wait between retrying requests\n(increases exponentially from this value)." + } + ] + }, + "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1443, + "kind": 32768, + "kindString": "Parameter", + "name": "min_delay_between_retries", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_SHORT", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1444, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_short", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_MEDIUM", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1445, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_medium", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_LONG", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1446, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_long", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum timeout cap for exponential timeout growth across retries." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_MAX", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1447, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_max", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Additional HTTP headers to include in all API requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1448, + "kind": 32768, + "kindString": "Parameter", + "name": "headers", + "type": { + "name": "dict[str, str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "str" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create an `ApifyClient` instance with a custom HTTP client.\n\nUse this alternative constructor when you want to provide your own HTTP client implementation\ninstead of the default one. The custom client is responsible for its own configuration\n(retries, timeouts, headers, etc.).\n\n### Usage\n\n```python\nfrom apify_client import ApifyClient\nfrom apify_client.http_clients import HttpClient, HttpResponse\n\nclass MyHttpClient(HttpClient):\n def call(self, *, method, url, **kwargs) -> HttpResponse:\n ...\n\nclient = ApifyClient.with_custom_http_client(\n token='MY-APIFY-TOKEN',\n http_client=MyHttpClient(),\n)\n```" + } + ] + }, + "decorations": [ + { + "name": "classmethod" + } + ], + "flags": {}, + "groups": [], + "id": 1449, + "module": "_apify_client", + "name": "with_custom_http_client", + "parsedDocstring": { + "text": "Create an `ApifyClient` instance with a custom HTTP client.\n\nUse this alternative constructor when you want to provide your own HTTP client implementation\ninstead of the default one. The custom client is responsible for its own configuration\n(retries, timeouts, headers, etc.).\n\n### Usage\n\n```python\nfrom apify_client import ApifyClient\nfrom apify_client.http_clients import HttpClient, HttpResponse\n\nclass MyHttpClient(HttpClient):\n def call(self, *, method, url, **kwargs) -> HttpResponse:\n ...\n\nclient = ApifyClient.with_custom_http_client(\n token='MY-APIFY-TOKEN',\n http_client=MyHttpClient(),\n)\n```", + "args": { + "token": "The Apify API token.", + "api_url": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com.", + "api_public_url": "The globally accessible URL of the Apify API server. Defaults to https://api.apify.com.", + "http_client": "A custom HTTP client instance extending `HttpClient`." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 210 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create an `ApifyClient` instance with a custom HTTP client.\n\nUse this alternative constructor when you want to provide your own HTTP client implementation\ninstead of the default one. The custom client is responsible for its own configuration\n(retries, timeouts, headers, etc.).\n\n### Usage\n\n```python\nfrom apify_client import ApifyClient\nfrom apify_client.http_clients import HttpClient, HttpResponse\n\nclass MyHttpClient(HttpClient):\n def call(self, *, method, url, **kwargs) -> HttpResponse:\n ...\n\nclient = ApifyClient.with_custom_http_client(\n token='MY-APIFY-TOKEN',\n http_client=MyHttpClient(),\n)\n```" + } + ] + }, + "flags": {}, + "id": 1450, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "with_custom_http_client", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Apify API token." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 1451, + "kind": 32768, + "kindString": "Parameter", + "name": "token", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com." + } + ] + }, + "defaultValue": "DEFAULT_API_URL", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1452, + "kind": 32768, + "kindString": "Parameter", + "name": "api_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The globally accessible URL of the Apify API server. Defaults to https://api.apify.com." + } + ] + }, + "defaultValue": "DEFAULT_API_URL", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1453, + "kind": 32768, + "kindString": "Parameter", + "name": "api_public_url", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A custom HTTP client instance extending `HttpClient`." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1454, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + } + ], + "type": { + "name": "ApifyClient", + "type": "reference", + "target": "1436" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Apify API token used by the client." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 1455, + "module": "_apify_client", + "name": "token", + "parsedDocstring": { + "text": "The Apify API token used by the client." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 251 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The HTTP client instance used for API communication.\n\nReturns the custom HTTP client if one was provided via `with_custom_http_client`,\nor the default `ImpitHttpClient` otherwise (lazily created on first access)." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 1456, + "module": "_apify_client", + "name": "http_client", + "parsedDocstring": { + "text": "The HTTP client instance used for API communication.\n\nReturns the custom HTTP client if one was provided via `with_custom_http_client`,\nor the default `ImpitHttpClient` otherwise (lazily created on first access)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 256 + } + ], + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific Actor.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1457, + "module": "_apify_client", + "name": "actor", + "parsedDocstring": { + "text": "Get the sub-client for a specific Actor.\n", + "args": { + "actor_id": "ID of the Actor to be manipulated." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 287 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific Actor.\n" + } + ] + }, + "flags": {}, + "id": 1458, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "actor", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the Actor to be manipulated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1459, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "ActorClient", + "type": "reference", + "target": "3404" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the Actor collection, allowing to list and create Actors." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1460, + "module": "_apify_client", + "name": "actors", + "parsedDocstring": { + "text": "Get the sub-client for the Actor collection, allowing to list and create Actors." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 295 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the Actor collection, allowing to list and create Actors." + } + ] + }, + "flags": {}, + "id": 1461, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "actors", + "parameters": [], + "type": { + "name": "ActorCollectionClient", + "type": "reference", + "target": "2262" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific Actor build.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1462, + "module": "_apify_client", + "name": "build", + "parsedDocstring": { + "text": "Get the sub-client for a specific Actor build.\n", + "args": { + "build_id": "ID of the Actor build to be manipulated." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 299 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific Actor build.\n" + } + ] + }, + "flags": {}, + "id": 1463, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "build", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the Actor build to be manipulated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1464, + "kind": 32768, + "kindString": "Parameter", + "name": "build_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "BuildClient", + "type": "reference", + "target": "3171" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the build collection, allowing to list builds." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1465, + "module": "_apify_client", + "name": "builds", + "parsedDocstring": { + "text": "Get the sub-client for the build collection, allowing to list builds." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 307 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the build collection, allowing to list builds." + } + ] + }, + "flags": {}, + "id": 1466, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "builds", + "parameters": [], + "type": { + "name": "BuildCollectionClient", + "type": "reference", + "target": "2778" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific Actor run.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1467, + "module": "_apify_client", + "name": "run", + "parsedDocstring": { + "text": "Get the sub-client for a specific Actor run.\n", + "args": { + "run_id": "ID of the Actor run to be manipulated." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 311 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific Actor run.\n" + } + ] + }, + "flags": {}, + "id": 1468, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "run", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the Actor run to be manipulated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1469, + "kind": 32768, + "kindString": "Parameter", + "name": "run_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "RunClient", + "type": "reference", + "target": "3033" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the run collection, allowing to list Actor runs." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1470, + "module": "_apify_client", + "name": "runs", + "parsedDocstring": { + "text": "Get the sub-client for the run collection, allowing to list Actor runs." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 319 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the run collection, allowing to list Actor runs." + } + ] + }, + "flags": {}, + "id": 1471, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "runs", + "parameters": [], + "type": { + "name": "RunCollectionClient", + "type": "reference", + "target": "3916" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific dataset.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1472, + "module": "_apify_client", + "name": "dataset", + "parsedDocstring": { + "text": "Get the sub-client for a specific dataset.\n", + "args": { + "dataset_id": "ID of the dataset to be manipulated." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 323 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific dataset.\n" + } + ] + }, + "flags": {}, + "id": 1473, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "dataset", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the dataset to be manipulated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1474, + "kind": 32768, + "kindString": "Parameter", + "name": "dataset_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "DatasetClient", + "type": "reference", + "target": "2819" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the dataset collection, allowing to list and create datasets." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1475, + "module": "_apify_client", + "name": "datasets", + "parsedDocstring": { + "text": "Get the sub-client for the dataset collection, allowing to list and create datasets." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 331 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the dataset collection, allowing to list and create datasets." + } + ] + }, + "flags": {}, + "id": 1476, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "datasets", + "parameters": [], + "type": { + "name": "DatasetCollectionClient", + "type": "reference", + "target": "3321" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific key-value store.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1477, + "module": "_apify_client", + "name": "key_value_store", + "parsedDocstring": { + "text": "Get the sub-client for a specific key-value store.\n", + "args": { + "key_value_store_id": "ID of the key-value store to be manipulated." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 335 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific key-value store.\n" + } + ] + }, + "flags": {}, + "id": 1478, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "key_value_store", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the key-value store to be manipulated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1479, + "kind": 32768, + "kindString": "Parameter", + "name": "key_value_store_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "KeyValueStoreClient", + "type": "reference", + "target": "3608" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the key-value store collection, allowing to list and create key-value stores." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1480, + "module": "_apify_client", + "name": "key_value_stores", + "parsedDocstring": { + "text": "Get the sub-client for the key-value store collection, allowing to list and create key-value stores." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 343 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the key-value store collection, allowing to list and create key-value stores." + } + ] + }, + "flags": {}, + "id": 1481, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "key_value_stores", + "parameters": [], + "type": { + "name": "KeyValueStoreCollectionClient", + "type": "reference", + "target": "2372" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific request queue.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1482, + "module": "_apify_client", + "name": "request_queue", + "parsedDocstring": { + "text": "Get the sub-client for a specific request queue.\n", + "args": { + "request_queue_id": "ID of the request queue to be manipulated.", + "client_key": "A unique identifier of the client accessing the request queue." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 347 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific request queue.\n" + } + ] + }, + "flags": {}, + "id": 1483, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "request_queue", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the request queue to be manipulated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1484, + "kind": 32768, + "kindString": "Parameter", + "name": "request_queue_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier of the client accessing the request queue." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1485, + "kind": 32768, + "kindString": "Parameter", + "name": "client_key", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "RequestQueueClient", + "type": "reference", + "target": "1996" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the request queue collection, allowing to list and create request queues." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1486, + "module": "_apify_client", + "name": "request_queues", + "parsedDocstring": { + "text": "Get the sub-client for the request queue collection, allowing to list and create request queues." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 356 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the request queue collection, allowing to list and create request queues." + } + ] + }, + "flags": {}, + "id": 1487, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "request_queues", + "parameters": [], + "type": { + "name": "RequestQueueCollectionClient", + "type": "reference", + "target": "2480" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific webhook.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1488, + "module": "_apify_client", + "name": "webhook", + "parsedDocstring": { + "text": "Get the sub-client for a specific webhook.\n", + "args": { + "webhook_id": "ID of the webhook to be manipulated." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 360 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific webhook.\n" + } + ] + }, + "flags": {}, + "id": 1489, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "webhook", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the webhook to be manipulated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1490, + "kind": 32768, + "kindString": "Parameter", + "name": "webhook_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "WebhookClient", + "type": "reference", + "target": "3856" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the webhook collection, allowing to list and create webhooks." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1491, + "module": "_apify_client", + "name": "webhooks", + "parsedDocstring": { + "text": "Get the sub-client for the webhook collection, allowing to list and create webhooks." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 368 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the webhook collection, allowing to list and create webhooks." + } + ] + }, + "flags": {}, + "id": 1492, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "webhooks", + "parameters": [], + "type": { + "name": "WebhookCollectionClient", + "type": "reference", + "target": "3794" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific webhook dispatch.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1493, + "module": "_apify_client", + "name": "webhook_dispatch", + "parsedDocstring": { + "text": "Get the sub-client for a specific webhook dispatch.\n", + "args": { + "webhook_dispatch_id": "ID of the webhook dispatch to access." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 372 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific webhook dispatch.\n" + } + ] + }, + "flags": {}, + "id": 1494, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "webhook_dispatch", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the webhook dispatch to access." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1495, + "kind": 32768, + "kindString": "Parameter", + "name": "webhook_dispatch_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "WebhookDispatchClient", + "type": "reference", + "target": "2354" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the webhook dispatch collection, allowing to list webhook dispatches." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1496, + "module": "_apify_client", + "name": "webhook_dispatches", + "parsedDocstring": { + "text": "Get the sub-client for the webhook dispatch collection, allowing to list webhook dispatches." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 380 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the webhook dispatch collection, allowing to list webhook dispatches." + } + ] + }, + "flags": {}, + "id": 1497, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "webhook_dispatches", + "parameters": [], + "type": { + "name": "WebhookDispatchCollectionClient", + "type": "reference", + "target": "2228" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific schedule.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1498, + "module": "_apify_client", + "name": "schedule", + "parsedDocstring": { + "text": "Get the sub-client for a specific schedule.\n", + "args": { + "schedule_id": "ID of the schedule to be manipulated." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 384 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific schedule.\n" + } + ] + }, + "flags": {}, + "id": 1499, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "schedule", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the schedule to be manipulated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1500, + "kind": 32768, + "kindString": "Parameter", + "name": "schedule_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "ScheduleClient", + "type": "reference", + "target": "1904" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the schedule collection, allowing to list and create schedules." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1501, + "module": "_apify_client", + "name": "schedules", + "parsedDocstring": { + "text": "Get the sub-client for the schedule collection, allowing to list and create schedules." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 392 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the schedule collection, allowing to list and create schedules." + } + ] + }, + "flags": {}, + "id": 1502, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "schedules", + "parameters": [], + "type": { + "name": "ScheduleCollectionClient", + "type": "reference", + "target": "3219" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for retrieving logs of an Actor build or run.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1503, + "module": "_apify_client", + "name": "log", + "parsedDocstring": { + "text": "Get the sub-client for retrieving logs of an Actor build or run.\n", + "args": { + "build_or_run_id": "ID of the Actor build or run for which to access the log." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 396 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for retrieving logs of an Actor build or run.\n" + } + ] + }, + "flags": {}, + "id": 1504, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "log", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the Actor build or run for which to access the log." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1505, + "kind": 32768, + "kindString": "Parameter", + "name": "build_or_run_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "LogClient", + "type": "reference", + "target": "2160" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific Actor task.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1506, + "module": "_apify_client", + "name": "task", + "parsedDocstring": { + "text": "Get the sub-client for a specific Actor task.\n", + "args": { + "task_id": "ID of the task to be manipulated." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 404 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific Actor task.\n" + } + ] + }, + "flags": {}, + "id": 1507, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "task", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the task to be manipulated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1508, + "kind": 32768, + "kindString": "Parameter", + "name": "task_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "TaskClient", + "type": "reference", + "target": "2648" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the task collection, allowing to list and create Actor tasks." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1509, + "module": "_apify_client", + "name": "tasks", + "parsedDocstring": { + "text": "Get the sub-client for the task collection, allowing to list and create Actor tasks." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 412 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the task collection, allowing to list and create Actor tasks." + } + ] + }, + "flags": {}, + "id": 1510, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "tasks", + "parameters": [], + "type": { + "name": "TaskCollectionClient", + "type": "reference", + "target": "2530" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for querying user data.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1511, + "module": "_apify_client", + "name": "user", + "parsedDocstring": { + "text": "Get the sub-client for querying user data.\n", + "args": { + "user_id": "ID of user to be queried. If None, queries the user belonging to the token supplied to the client." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 416 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for querying user data.\n" + } + ] + }, + "flags": {}, + "id": 1512, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "user", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of user to be queried. If None, queries the user belonging to the token supplied to the client." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 1513, + "kind": 32768, + "kindString": "Parameter", + "name": "user_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "UserClient", + "type": "reference", + "target": "1956" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the Apify Store, allowing to list Actors published in the store." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1514, + "module": "_apify_client", + "name": "store", + "parsedDocstring": { + "text": "Get the sub-client for the Apify Store, allowing to list Actors published in the store." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 424 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the Apify Store, allowing to list Actors published in the store." + } + ] + }, + "flags": {}, + "id": 1515, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "store", + "parameters": [], + "type": { + "name": "StoreCollectionClient", + "type": "reference", + "target": "2598" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Synchronous client for the Apify API.\n\nThis is the main entry point for interacting with the Apify platform. It provides methods to access\nresource-specific sub-clients for managing Actors, runs, datasets, key-value stores, request queues,\nschedules, webhooks, and more.\n\nThe client automatically handles retries with exponential backoff for failed or rate-limited requests.\n\n### Usage\n\n```python\nfrom apify_client import ApifyClient\n\nclient = ApifyClient(token='MY-APIFY-TOKEN')\n\n# Start an Actor and wait for it to finish.\nactor_client = client.actor('apify/python-example')\nrun = actor_client.call(run_input={'first_number': 1, 'second_number': 2})\n\n# Fetch results from the run's default dataset.\nif run is not None:\n dataset_client = client.dataset(run.default_dataset_id)\n items = dataset_client.list_items().items\n for item in items:\n print(item)\n```" + } + ] + }, + "decorations": [ + { + "args": "('Apify API clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1437, + 1457, + 1460, + 1462, + 1465, + 1472, + 1475, + 1477, + 1480, + 1503, + 1482, + 1486, + 1467, + 1470, + 1498, + 1501, + 1514, + 1506, + 1509, + 1511, + 1488, + 1493, + 1496, + 1491, + 1449 + ], + "title": "Methods" + }, + { + "children": [ + 1456, + 1455 + ], + "title": "Properties" + } + ], + "id": 1436, + "module": "_apify_client", + "name": "ApifyClient", + "parsedDocstring": { + "text": "Synchronous client for the Apify API.\n\nThis is the main entry point for interacting with the Apify platform. It provides methods to access\nresource-specific sub-clients for managing Actors, runs, datasets, key-value stores, request queues,\nschedules, webhooks, and more.\n\nThe client automatically handles retries with exponential backoff for failed or rate-limited requests.\n\n### Usage\n\n```python\nfrom apify_client import ApifyClient\n\nclient = ApifyClient(token='MY-APIFY-TOKEN')\n\n# Start an Actor and wait for it to finish.\nactor_client = client.actor('apify/python-example')\nrun = actor_client.call(run_input={'first_number': 1, 'second_number': 2})\n\n# Fetch results from the run's default dataset.\nif run is not None:\n dataset_client = client.dataset(run.default_dataset_id)\n items = dataset_client.list_items().items\n for item in items:\n print(item)\n```" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 83 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the Apify API client.\n\nTo use a custom HTTP client, use the `with_custom_http_client` class method instead.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1517, + "module": "_apify_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the Apify API client.\n\nTo use a custom HTTP client, use the `with_custom_http_client` class method instead.\n", + "args": { + "token": "The Apify API token. You can find your token on the\n[Integrations](https://console.apify.com/account/integrations) page in the Apify Console.", + "api_url": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com. It can\nbe an internal URL that is not globally accessible, in which case `api_public_url` should be set\nas well.", + "api_public_url": "The globally accessible URL of the Apify API server. Should be set only if `api_url`\nis an internal URL that is not globally accessible. Defaults to https://api.apify.com.", + "max_retries": "How many times to retry a failed request at most.", + "min_delay_between_retries": "How long will the client wait between retrying requests\n(increases exponentially from this value).", + "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).", + "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).", + "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).", + "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.", + "headers": "Additional HTTP headers to include in all API requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 466 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the Apify API client.\n\nTo use a custom HTTP client, use the `with_custom_http_client` class method instead.\n" + } + ] + }, + "flags": {}, + "id": 1518, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Apify API token. You can find your token on the\n[Integrations](https://console.apify.com/account/integrations) page in the Apify Console." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 1519, + "kind": 32768, + "kindString": "Parameter", + "name": "token", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com. It can\nbe an internal URL that is not globally accessible, in which case `api_public_url` should be set\nas well." + } + ] + }, + "defaultValue": "DEFAULT_API_URL", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1520, + "kind": 32768, + "kindString": "Parameter", + "name": "api_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The globally accessible URL of the Apify API server. Should be set only if `api_url`\nis an internal URL that is not globally accessible. Defaults to https://api.apify.com." + } + ] + }, + "defaultValue": "DEFAULT_API_URL", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1521, + "kind": 32768, + "kindString": "Parameter", + "name": "api_public_url", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many times to retry a failed request at most." + } + ] + }, + "defaultValue": "DEFAULT_MAX_RETRIES", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1522, + "kind": 32768, + "kindString": "Parameter", + "name": "max_retries", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How long will the client wait between retrying requests\n(increases exponentially from this value)." + } + ] + }, + "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1523, + "kind": 32768, + "kindString": "Parameter", + "name": "min_delay_between_retries", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_SHORT", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1524, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_short", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_MEDIUM", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1525, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_medium", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_LONG", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1526, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_long", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum timeout cap for exponential timeout growth across retries." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_MAX", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1527, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_max", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Additional HTTP headers to include in all API requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1528, + "kind": 32768, + "kindString": "Parameter", + "name": "headers", + "type": { + "name": "dict[str, str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "str" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create an `ApifyClientAsync` instance with a custom HTTP client.\n\nUse this alternative constructor when you want to provide your own HTTP client implementation\ninstead of the default one. The custom client is responsible for its own configuration\n(retries, timeouts, headers, etc.).\n\n### Usage\n\n```python\nfrom apify_client import ApifyClientAsync\nfrom apify_client.http_clients import HttpClientAsync, HttpResponse\n\nclass MyHttpClient(HttpClientAsync):\n async def call(self, *, method, url, **kwargs) -> HttpResponse:\n ...\n\nclient = ApifyClientAsync.with_custom_http_client(\n token='MY-APIFY-TOKEN',\n http_client=MyHttpClient(),\n)\n```" + } + ] + }, + "decorations": [ + { + "name": "classmethod" + } + ], + "flags": {}, + "groups": [], + "id": 1529, + "module": "_apify_client", + "name": "with_custom_http_client", + "parsedDocstring": { + "text": "Create an `ApifyClientAsync` instance with a custom HTTP client.\n\nUse this alternative constructor when you want to provide your own HTTP client implementation\ninstead of the default one. The custom client is responsible for its own configuration\n(retries, timeouts, headers, etc.).\n\n### Usage\n\n```python\nfrom apify_client import ApifyClientAsync\nfrom apify_client.http_clients import HttpClientAsync, HttpResponse\n\nclass MyHttpClient(HttpClientAsync):\n async def call(self, *, method, url, **kwargs) -> HttpResponse:\n ...\n\nclient = ApifyClientAsync.with_custom_http_client(\n token='MY-APIFY-TOKEN',\n http_client=MyHttpClient(),\n)\n```", + "args": { + "token": "The Apify API token.", + "api_url": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com.", + "api_public_url": "The globally accessible URL of the Apify API server. Defaults to https://api.apify.com.", + "http_client": "A custom HTTP client instance extending `HttpClientAsync`." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 564 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create an `ApifyClientAsync` instance with a custom HTTP client.\n\nUse this alternative constructor when you want to provide your own HTTP client implementation\ninstead of the default one. The custom client is responsible for its own configuration\n(retries, timeouts, headers, etc.).\n\n### Usage\n\n```python\nfrom apify_client import ApifyClientAsync\nfrom apify_client.http_clients import HttpClientAsync, HttpResponse\n\nclass MyHttpClient(HttpClientAsync):\n async def call(self, *, method, url, **kwargs) -> HttpResponse:\n ...\n\nclient = ApifyClientAsync.with_custom_http_client(\n token='MY-APIFY-TOKEN',\n http_client=MyHttpClient(),\n)\n```" + } + ] + }, + "flags": {}, + "id": 1530, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "with_custom_http_client", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Apify API token." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 1531, + "kind": 32768, + "kindString": "Parameter", + "name": "token", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the Apify API server to connect to. Defaults to https://api.apify.com." + } + ] + }, + "defaultValue": "DEFAULT_API_URL", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1532, + "kind": 32768, + "kindString": "Parameter", + "name": "api_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The globally accessible URL of the Apify API server. Defaults to https://api.apify.com." + } + ] + }, + "defaultValue": "DEFAULT_API_URL", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1533, + "kind": 32768, + "kindString": "Parameter", + "name": "api_public_url", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A custom HTTP client instance extending `HttpClientAsync`." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1534, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + } + ], + "type": { + "name": "ApifyClientAsync", + "type": "reference", + "target": "1516" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Apify API token used by the client." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 1535, + "module": "_apify_client", + "name": "token", + "parsedDocstring": { + "text": "The Apify API token used by the client." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 605 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The HTTP client instance used for API communication.\n\nReturns the custom HTTP client if one was provided via `with_custom_http_client`,\nor the default `ImpitHttpClientAsync` otherwise (lazily created on first access)." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 1536, + "module": "_apify_client", + "name": "http_client", + "parsedDocstring": { + "text": "The HTTP client instance used for API communication.\n\nReturns the custom HTTP client if one was provided via `with_custom_http_client`,\nor the default `ImpitHttpClientAsync` otherwise (lazily created on first access)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 610 + } + ], + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific Actor.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1537, + "module": "_apify_client", + "name": "actor", + "parsedDocstring": { + "text": "Get the sub-client for a specific Actor.\n", + "args": { + "actor_id": "ID of the Actor to be manipulated." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 640 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific Actor.\n" + } + ] + }, + "flags": {}, + "id": 1538, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "actor", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the Actor to be manipulated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1539, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "ActorClientAsync", + "type": "reference", + "target": "3506" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the Actor collection, allowing to list and create Actors." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1540, + "module": "_apify_client", + "name": "actors", + "parsedDocstring": { + "text": "Get the sub-client for the Actor collection, allowing to list and create Actors." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 648 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the Actor collection, allowing to list and create Actors." + } + ] + }, + "flags": {}, + "id": 1541, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "actors", + "parameters": [], + "type": { + "name": "ActorCollectionClientAsync", + "type": "reference", + "target": "2308" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific Actor build.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1542, + "module": "_apify_client", + "name": "build", + "parsedDocstring": { + "text": "Get the sub-client for a specific Actor build.\n", + "args": { + "build_id": "ID of the Actor build to be manipulated." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 652 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific Actor build.\n" + } + ] + }, + "flags": {}, + "id": 1543, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "build", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the Actor build to be manipulated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1544, + "kind": 32768, + "kindString": "Parameter", + "name": "build_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "BuildClientAsync", + "type": "reference", + "target": "3195" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the build collection, allowing to list builds." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1545, + "module": "_apify_client", + "name": "builds", + "parsedDocstring": { + "text": "Get the sub-client for the build collection, allowing to list builds." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 660 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the build collection, allowing to list builds." + } + ] + }, + "flags": {}, + "id": 1546, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "builds", + "parameters": [], + "type": { + "name": "BuildCollectionClientAsync", + "type": "reference", + "target": "2795" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific Actor run.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1547, + "module": "_apify_client", + "name": "run", + "parsedDocstring": { + "text": "Get the sub-client for a specific Actor run.\n", + "args": { + "run_id": "ID of the Actor run to be manipulated." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 664 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific Actor run.\n" + } + ] + }, + "flags": {}, + "id": 1548, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "run", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the Actor run to be manipulated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1549, + "kind": 32768, + "kindString": "Parameter", + "name": "run_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "RunClientAsync", + "type": "reference", + "target": "3102" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the run collection, allowing to list Actor runs." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1550, + "module": "_apify_client", + "name": "runs", + "parsedDocstring": { + "text": "Get the sub-client for the run collection, allowing to list Actor runs." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 672 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the run collection, allowing to list Actor runs." + } + ] + }, + "flags": {}, + "id": 1551, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "runs", + "parameters": [], + "type": { + "name": "RunCollectionClientAsync", + "type": "reference", + "target": "3939" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific dataset.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1552, + "module": "_apify_client", + "name": "dataset", + "parsedDocstring": { + "text": "Get the sub-client for a specific dataset.\n", + "args": { + "dataset_id": "ID of the dataset to be manipulated." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 676 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific dataset.\n" + } + ] + }, + "flags": {}, + "id": 1553, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "dataset", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the dataset to be manipulated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1554, + "kind": 32768, + "kindString": "Parameter", + "name": "dataset_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "DatasetClientAsync", + "type": "reference", + "target": "2926" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the dataset collection, allowing to list and create datasets." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1555, + "module": "_apify_client", + "name": "datasets", + "parsedDocstring": { + "text": "Get the sub-client for the dataset collection, allowing to list and create datasets." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 684 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the dataset collection, allowing to list and create datasets." + } + ] + }, + "flags": {}, + "id": 1556, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "datasets", + "parameters": [], + "type": { + "name": "DatasetCollectionClientAsync", + "type": "reference", + "target": "3347" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific key-value store.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1557, + "module": "_apify_client", + "name": "key_value_store", + "parsedDocstring": { + "text": "Get the sub-client for a specific key-value store.\n", + "args": { + "key_value_store_id": "ID of the key-value store to be manipulated." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 688 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific key-value store.\n" + } + ] + }, + "flags": {}, + "id": 1558, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "key_value_store", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the key-value store to be manipulated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1559, + "kind": 32768, + "kindString": "Parameter", + "name": "key_value_store_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "KeyValueStoreClientAsync", + "type": "reference", + "target": "3683" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the key-value store collection, allowing to list and create key-value stores." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1560, + "module": "_apify_client", + "name": "key_value_stores", + "parsedDocstring": { + "text": "Get the sub-client for the key-value store collection, allowing to list and create key-value stores." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 696 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the key-value store collection, allowing to list and create key-value stores." + } + ] + }, + "flags": {}, + "id": 1561, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "key_value_stores", + "parameters": [], + "type": { + "name": "KeyValueStoreCollectionClientAsync", + "type": "reference", + "target": "2398" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific request queue.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1562, + "module": "_apify_client", + "name": "request_queue", + "parsedDocstring": { + "text": "Get the sub-client for a specific request queue.\n", + "args": { + "request_queue_id": "ID of the request queue to be manipulated.", + "client_key": "A unique identifier of the client accessing the request queue." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 700 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific request queue.\n" + } + ] + }, + "flags": {}, + "id": 1563, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "request_queue", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the request queue to be manipulated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1564, + "kind": 32768, + "kindString": "Parameter", + "name": "request_queue_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier of the client accessing the request queue." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1565, + "kind": 32768, + "kindString": "Parameter", + "name": "client_key", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "RequestQueueClientAsync", + "type": "reference", + "target": "2078" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the request queue collection, allowing to list and create request queues." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1566, + "module": "_apify_client", + "name": "request_queues", + "parsedDocstring": { + "text": "Get the sub-client for the request queue collection, allowing to list and create request queues." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 709 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the request queue collection, allowing to list and create request queues." + } + ] + }, + "flags": {}, + "id": 1567, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "request_queues", + "parameters": [], + "type": { + "name": "RequestQueueCollectionClientAsync", + "type": "reference", + "target": "2505" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific webhook.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1568, + "module": "_apify_client", + "name": "webhook", + "parsedDocstring": { + "text": "Get the sub-client for a specific webhook.\n", + "args": { + "webhook_id": "ID of the webhook to be manipulated." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 713 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific webhook.\n" + } + ] + }, + "flags": {}, + "id": 1569, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "webhook", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the webhook to be manipulated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1570, + "kind": 32768, + "kindString": "Parameter", + "name": "webhook_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "WebhookClientAsync", + "type": "reference", + "target": "3886" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the webhook collection, allowing to list and create webhooks." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1571, + "module": "_apify_client", + "name": "webhooks", + "parsedDocstring": { + "text": "Get the sub-client for the webhook collection, allowing to list and create webhooks." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 721 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the webhook collection, allowing to list and create webhooks." + } + ] + }, + "flags": {}, + "id": 1572, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "webhooks", + "parameters": [], + "type": { + "name": "WebhookCollectionClientAsync", + "type": "reference", + "target": "3825" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific webhook dispatch.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1573, + "module": "_apify_client", + "name": "webhook_dispatch", + "parsedDocstring": { + "text": "Get the sub-client for a specific webhook dispatch.\n", + "args": { + "webhook_dispatch_id": "ID of the webhook dispatch to access." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 725 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific webhook dispatch.\n" + } + ] + }, + "flags": {}, + "id": 1574, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "webhook_dispatch", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the webhook dispatch to access." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1575, + "kind": 32768, + "kindString": "Parameter", + "name": "webhook_dispatch_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "WebhookDispatchClientAsync", + "type": "reference", + "target": "2363" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the webhook dispatch collection, allowing to list webhook dispatches." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1576, + "module": "_apify_client", + "name": "webhook_dispatches", + "parsedDocstring": { + "text": "Get the sub-client for the webhook dispatch collection, allowing to list webhook dispatches." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 733 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the webhook dispatch collection, allowing to list webhook dispatches." + } + ] + }, + "flags": {}, + "id": 1577, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "webhook_dispatches", + "parameters": [], + "type": { + "name": "WebhookDispatchCollectionClientAsync", + "type": "reference", + "target": "2245" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific schedule.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1578, + "module": "_apify_client", + "name": "schedule", + "parsedDocstring": { + "text": "Get the sub-client for a specific schedule.\n", + "args": { + "schedule_id": "ID of the schedule to be manipulated." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 737 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific schedule.\n" + } + ] + }, + "flags": {}, + "id": 1579, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "schedule", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the schedule to be manipulated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1580, + "kind": 32768, + "kindString": "Parameter", + "name": "schedule_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "ScheduleClientAsync", + "type": "reference", + "target": "1930" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the schedule collection, allowing to list and create schedules." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1581, + "module": "_apify_client", + "name": "schedules", + "parsedDocstring": { + "text": "Get the sub-client for the schedule collection, allowing to list and create schedules." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 745 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the schedule collection, allowing to list and create schedules." + } + ] + }, + "flags": {}, + "id": 1582, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "schedules", + "parameters": [], + "type": { + "name": "ScheduleCollectionClientAsync", + "type": "reference", + "target": "3247" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for retrieving logs of an Actor build or run.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1583, + "module": "_apify_client", + "name": "log", + "parsedDocstring": { + "text": "Get the sub-client for retrieving logs of an Actor build or run.\n", + "args": { + "build_or_run_id": "ID of the Actor build or run for which to access the log." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 749 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for retrieving logs of an Actor build or run.\n" + } + ] + }, + "flags": {}, + "id": 1584, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "log", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the Actor build or run for which to access the log." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1585, + "kind": 32768, + "kindString": "Parameter", + "name": "build_or_run_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "LogClientAsync", + "type": "reference", + "target": "2177" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific Actor task.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1586, + "module": "_apify_client", + "name": "task", + "parsedDocstring": { + "text": "Get the sub-client for a specific Actor task.\n", + "args": { + "task_id": "ID of the task to be manipulated." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 757 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for a specific Actor task.\n" + } + ] + }, + "flags": {}, + "id": 1587, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "task", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the task to be manipulated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1588, + "kind": 32768, + "kindString": "Parameter", + "name": "task_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "TaskClientAsync", + "type": "reference", + "target": "2713" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the task collection, allowing to list and create Actor tasks." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1589, + "module": "_apify_client", + "name": "tasks", + "parsedDocstring": { + "text": "Get the sub-client for the task collection, allowing to list and create Actor tasks." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 765 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the task collection, allowing to list and create Actor tasks." + } + ] + }, + "flags": {}, + "id": 1590, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "tasks", + "parameters": [], + "type": { + "name": "TaskCollectionClientAsync", + "type": "reference", + "target": "2564" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for querying user data.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1591, + "module": "_apify_client", + "name": "user", + "parsedDocstring": { + "text": "Get the sub-client for querying user data.\n", + "args": { + "user_id": "ID of user to be queried. If None, queries the user belonging to the token supplied to the client." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 769 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for querying user data.\n" + } + ] + }, + "flags": {}, + "id": 1592, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "user", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of user to be queried. If None, queries the user belonging to the token supplied to the client." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 1593, + "kind": 32768, + "kindString": "Parameter", + "name": "user_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "UserClientAsync", + "type": "reference", + "target": "1976" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the Apify Store, allowing to list Actors published in the store." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1594, + "module": "_apify_client", + "name": "store", + "parsedDocstring": { + "text": "Get the sub-client for the Apify Store, allowing to list Actors published in the store." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 777 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the sub-client for the Apify Store, allowing to list Actors published in the store." + } + ] + }, + "flags": {}, + "id": 1595, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "store", + "parameters": [], + "type": { + "name": "StoreCollectionClientAsync", + "type": "reference", + "target": "2623" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Asynchronous client for the Apify API.\n\nThis is the main entry point for interacting with the Apify platform using async/await. It provides\nmethods to access resource-specific sub-clients for managing Actors, runs, datasets, key-value stores,\nrequest queues, schedules, webhooks, and more.\n\nThe client automatically handles retries with exponential backoff for failed or rate-limited requests.\n\n### Usage\n\n```python\nimport asyncio\n\nfrom apify_client import ApifyClientAsync\n\n\nasync def main() -> None:\n client = ApifyClientAsync(token='MY-APIFY-TOKEN')\n\n # Start an Actor and wait for it to finish.\n actor_client = client.actor('apify/python-example')\n run = await actor_client.call(run_input={'first_number': 1, 'second_number': 2})\n\n # Fetch results from the run's default dataset.\n if run is not None:\n dataset_client = client.dataset(run.default_dataset_id)\n items = (await dataset_client.list_items()).items\n for item in items:\n print(item)\n\n\nasyncio.run(main())\n```" + } + ] + }, + "decorations": [ + { + "args": "('Apify API clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1517, + 1537, + 1540, + 1542, + 1545, + 1552, + 1555, + 1557, + 1560, + 1583, + 1562, + 1566, + 1547, + 1550, + 1578, + 1581, + 1594, + 1586, + 1589, + 1591, + 1568, + 1573, + 1576, + 1571, + 1529 + ], + "title": "Methods" + }, + { + "children": [ + 1536, + 1535 + ], + "title": "Properties" + } + ], + "id": 1516, + "module": "_apify_client", + "name": "ApifyClientAsync", + "parsedDocstring": { + "text": "Asynchronous client for the Apify API.\n\nThis is the main entry point for interacting with the Apify platform using async/await. It provides\nmethods to access resource-specific sub-clients for managing Actors, runs, datasets, key-value stores,\nrequest queues, schedules, webhooks, and more.\n\nThe client automatically handles retries with exponential backoff for failed or rate-limited requests.\n\n### Usage\n\n```python\nimport asyncio\n\nfrom apify_client import ApifyClientAsync\n\n\nasync def main() -> None:\n client = ApifyClientAsync(token='MY-APIFY-TOKEN')\n\n # Start an Actor and wait for it to finish.\n actor_client = client.actor('apify/python-example')\n run = await actor_client.call(run_input={'first_number': 1, 'second_number': 2})\n\n # Fetch results from the run's default dataset.\n if run is not None:\n dataset_client = client.dataset(run.default_dataset_id)\n items = (await dataset_client.list_items()).items\n for item in items:\n print(item)\n\n\nasyncio.run(main())\n```" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_apify_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 430 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1596, + "module": "__init__", + "name": "__version__", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/__init__.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 5 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the logger used throughout the library." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1597, + "module": "_logging", + "name": "logger_name", + "parsedDocstring": { + "text": "Name of the logger used throughout the library." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_logging.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 19 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Logger used throughout the library." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1598, + "module": "_logging", + "name": "logger", + "parsedDocstring": { + "text": "Logger used throughout the library." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_logging.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 22 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1600, + "module": "_logging", + "name": "attempt", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_logging.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 29 + } + ], + "type": { + "name": "ContextVar", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1601, + "module": "_logging", + "name": "client_method", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_logging.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 30 + } + ], + "type": { + "name": "ContextVar", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1602, + "module": "_logging", + "name": "method", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_logging.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 31 + } + ], + "type": { + "name": "ContextVar", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1603, + "module": "_logging", + "name": "resource_id", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_logging.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 32 + } + ], + "type": { + "name": "ContextVar", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1604, + "module": "_logging", + "name": "url", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_logging.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 33 + } + ], + "type": { + "name": "ContextVar", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Request context details for logging (attempt, client method, HTTP method, resource ID, URL)." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 1600, + 1601, + 1602, + 1603, + 1604 + ], + "title": "Properties" + } + ], + "id": 1599, + "module": "_logging", + "name": "LogContext", + "parsedDocstring": { + "text": "Request context details for logging (attempt, client method, HTTP method, resource ID, URL)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_logging.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 26 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1605, + "module": "_logging", + "name": "log_context", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_logging.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 36 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wrap all public methods in the class with logging context injection." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1607, + "module": "_logging", + "name": "__new__", + "parsedDocstring": { + "text": "Wrap all public methods in the class with logging context injection." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_logging.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 48 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wrap all public methods in the class with logging context injection." + } + ] + }, + "flags": {}, + "id": 1608, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__new__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1609, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1610, + "kind": 32768, + "kindString": "Parameter", + "name": "bases", + "type": { + "name": "tuple", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1611, + "kind": 32768, + "kindString": "Parameter", + "name": "attrs", + "type": { + "name": "dict", + "type": "reference" + } + } + ], + "type": { + "name": "WithLogDetailsClient", + "type": "reference", + "target": "1606" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Metaclass that wraps public methods to inject client details into log context." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 1607 + ], + "title": "Methods" + } + ], + "id": 1606, + "module": "_logging", + "name": "WithLogDetailsClient", + "parsedDocstring": { + "text": "Metaclass that wraps public methods to inject client details into log context." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_logging.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 45 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Format log by prepending colored logger name.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1613, + "module": "_logging", + "name": "format", + "parsedDocstring": { + "text": "Format log by prepending colored logger name.\n", + "args": { + "record": "The log record to format.\n" + }, + "returns": "Formatted log message with colored logger name prefix." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_logging.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 60 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Formatted log message with colored logger name prefix." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Format log by prepending colored logger name.\n" + } + ] + }, + "flags": {}, + "id": 1614, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "format", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The log record to format.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1615, + "kind": 32768, + "kindString": "Parameter", + "name": "record", + "type": { + "name": "logging.LogRecord", + "type": "reference" + } + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Log formatter that prepends colored logger name to messages." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 1613 + ], + "title": "Methods" + } + ], + "id": 1612, + "module": "_logging", + "name": "RedirectLogFormatter", + "parsedDocstring": { + "text": "Log formatter that prepends colored logger name to messages." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_logging.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 57 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a logger for redirecting logs from another Actor.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1616, + "module": "_logging", + "name": "create_redirect_logger", + "parsedDocstring": { + "text": "Create a logger for redirecting logs from another Actor.\n", + "args": { + "name": "Logger name. Use dot notation for hierarchy (e.g., \"apify.xyz\" creates \"xyz\" under \"apify\").\n" + }, + "returns": "Configured logger with RedirectLogFormatter." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_logging.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 74 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Configured logger with RedirectLogFormatter." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Create a logger for redirecting logs from another Actor.\n" + } + ] + }, + "flags": {}, + "id": 1617, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "create_redirect_logger", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Logger name. Use dot notation for hierarchy (e.g., \"apify.xyz\" creates \"xyz\" under \"apify\").\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1618, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "logging.Logger", + "type": "reference" + } + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add log context variables to the record." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1620, + "module": "_logging", + "name": "filter", + "parsedDocstring": { + "text": "Add log context variables to the record." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_logging.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 102 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add log context variables to the record." + } + ] + }, + "flags": {}, + "id": 1621, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "filter", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1622, + "kind": 32768, + "kindString": "Parameter", + "name": "record", + "type": { + "name": "logging.LogRecord", + "type": "reference" + } + } + ], + "type": { + "name": "bool", + "type": "reference" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter that injects current log context into all log records." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 1620 + ], + "title": "Methods" + } + ], + "id": 1619, + "module": "_logging", + "name": "_ContextInjectingFilter", + "parsedDocstring": { + "text": "Filter that injects current log context into all log records." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_logging.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 99 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1623, + "module": "_utils", + "name": "T", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 27 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Convert timedelta to seconds.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1624, + "module": "_utils", + "name": "to_seconds", + "parsedDocstring": { + "text": "Convert timedelta to seconds.\n", + "args": { + "td": "The timedelta to convert, or None.", + "as_int": "If True, round and return as int. Defaults to False.\n" + }, + "returns": "The total seconds as a float (or int if as_int=True), or None if input is None." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 43 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The total seconds as a float (or int if as_int=True), or None if input is None." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Convert timedelta to seconds.\n" + } + ] + }, + "flags": {}, + "id": 1625, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "to_seconds", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The timedelta to convert, or None." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1626, + "kind": 32768, + "kindString": "Parameter", + "name": "td", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, round and return as int. Defaults to False.\n" + } + ] + }, + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1627, + "kind": 32768, + "kindString": "Parameter", + "name": "as_int", + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "type": { + "name": "float | int | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "float" + }, + { + "type": "reference", + "name": "int" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Suppress 404 Not Found errors and re-raise all other API errors.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1628, + "module": "_utils", + "name": "catch_not_found_or_throw", + "parsedDocstring": { + "text": "Suppress 404 Not Found errors and re-raise all other API errors.\n", + "args": { + "exc": "The API error to check.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 59 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Suppress 404 Not Found errors and re-raise all other API errors.\n" + } + ] + }, + "flags": {}, + "id": 1629, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "catch_not_found_or_throw", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The API error to check.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1630, + "kind": 32768, + "kindString": "Parameter", + "name": "exc", + "type": { + "name": "ApifyApiError", + "type": "reference", + "target": "17" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Like `catch_not_found_or_throw`, but only suppress 404s when the client targets a specific resource by ID.\n\nFor chained clients without a `resource_id` (e.g. `run.dataset()`, `run.log()`), a 404 could mean either the\nparent or the default sub-resource is missing — the API body cannot disambiguate — so the error propagates\nrather than being swallowed." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1631, + "module": "_utils", + "name": "catch_not_found_for_resource_or_throw", + "parsedDocstring": { + "text": "Like `catch_not_found_or_throw`, but only suppress 404s when the client targets a specific resource by ID.\n\nFor chained clients without a `resource_id` (e.g. `run.dataset()`, `run.log()`), a 404 could mean either the\nparent or the default sub-resource is missing — the API body cannot disambiguate — so the error propagates\nrather than being swallowed." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Like `catch_not_found_or_throw`, but only suppress 404s when the client targets a specific resource by ID.\n\nFor chained clients without a `resource_id` (e.g. `run.dataset()`, `run.log()`), a 404 could mean either the\nparent or the default sub-resource is missing — the API body cannot disambiguate — so the error propagates\nrather than being swallowed." + } + ] + }, + "flags": {}, + "id": 1632, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "catch_not_found_for_resource_or_throw", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1633, + "kind": 32768, + "kindString": "Parameter", + "name": "exc", + "type": { + "name": "ApifyApiError", + "type": "reference", + "target": "17" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1634, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Encode a value for storage in a key-value store record.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1635, + "module": "_utils", + "name": "encode_key_value_store_record_value", + "parsedDocstring": { + "text": "Encode a value for storage in a key-value store record.\n", + "args": { + "value": "The value to encode (can be dict, str, bytes, or file-like object).", + "content_type": "The content type; if None, it's inferred from the value type.\n" + }, + "returns": "A tuple of (encoded_value, content_type)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 84 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A tuple of (encoded_value, content_type)." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Encode a value for storage in a key-value store record.\n" + } + ] + }, + "flags": {}, + "id": 1636, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "encode_key_value_store_record_value", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value to encode (can be dict, str, bytes, or file-like object)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1637, + "kind": 32768, + "kindString": "Parameter", + "name": "value", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type; if None, it's inferred from the value type.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1638, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "tuple", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Any" + }, + { + "type": "reference", + "name": "str" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if the given error is retryable.\n\nAll `impit.HTTPError` subclasses are considered retryable because they represent transport-level failures\n(network issues, timeouts, protocol errors, body decoding errors) that are typically transient. HTTP status\ncode errors are handled separately in `_make_request` based on the response status code, not here." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1639, + "module": "_utils", + "name": "is_retryable_error", + "parsedDocstring": { + "text": "Check if the given error is retryable.\n\nAll `impit.HTTPError` subclasses are considered retryable because they represent transport-level failures\n(network issues, timeouts, protocol errors, body decoding errors) that are typically transient. HTTP status\ncode errors are handled separately in `_make_request` based on the response status code, not here." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 118 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if the given error is retryable.\n\nAll `impit.HTTPError` subclasses are considered retryable because they represent transport-level failures\n(network issues, timeouts, protocol errors, body decoding errors) that are typically transient. HTTP status\ncode errors are handled separately in `_make_request` based on the response status code, not here." + } + ] + }, + "flags": {}, + "id": 1640, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "is_retryable_error", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1641, + "kind": 32768, + "kindString": "Parameter", + "name": "exc", + "type": { + "name": "Exception", + "type": "reference" + } + } + ], + "type": { + "name": "bool", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Convert a resource ID to URL-safe format by replacing forward slashes with tildes.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1642, + "module": "_utils", + "name": "to_safe_id", + "parsedDocstring": { + "text": "Convert a resource ID to URL-safe format by replacing forward slashes with tildes.\n", + "args": { + "id": "The resource identifier in format `resource_id` or `username/resource_id`.\n" + }, + "returns": "The resource identifier with `/` characters replaced by `~`." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 134 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The resource identifier with `/` characters replaced by `~`." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Convert a resource ID to URL-safe format by replacing forward slashes with tildes.\n" + } + ] + }, + "flags": {}, + "id": 1643, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "to_safe_id", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The resource identifier in format `resource_id` or `username/resource_id`.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1644, + "kind": 32768, + "kindString": "Parameter", + "name": "id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parse the API response as a dictionary and validate its type.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1645, + "module": "_utils", + "name": "response_to_dict", + "parsedDocstring": { + "text": "Parse the API response as a dictionary and validate its type.\n", + "args": { + "response": "The HTTP response object from the API.\n" + }, + "returns": "The parsed response as a dictionary." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 146 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The parsed response as a dictionary." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Parse the API response as a dictionary and validate its type.\n" + } + ] + }, + "flags": {}, + "id": 1646, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "response_to_dict", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The HTTP response object from the API.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1647, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + } + ], + "type": { + "name": "dict", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parse the API response as a list and validate its type.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1648, + "module": "_utils", + "name": "response_to_list", + "parsedDocstring": { + "text": "Parse the API response as a list and validate its type.\n", + "args": { + "response": "The HTTP response object from the API.\n" + }, + "returns": "The parsed response as a list." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 166 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The parsed response as a list." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Parse the API response as a list and validate its type.\n" + } + ] + }, + "flags": {}, + "id": 1649, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "response_to_list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The HTTP response object from the API.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1650, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + } + ], + "type": { + "name": "list", + "type": "reference", + "target": "2199" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Encode an integer to a base62 string.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1651, + "module": "_utils", + "name": "encode_base62", + "parsedDocstring": { + "text": "Encode an integer to a base62 string.\n", + "args": { + "num": "The number to encode.\n" + }, + "returns": "The base62-encoded string." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 189 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The base62-encoded string." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Encode an integer to a base62 string.\n" + } + ] + }, + "flags": {}, + "id": 1652, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "encode_base62", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number to encode.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1653, + "kind": 32768, + "kindString": "Parameter", + "name": "num", + "type": { + "name": "int", + "type": "reference" + } + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate an HMAC-SHA256 signature and encode it using base62.\n\nThe HMAC signature is truncated to 30 characters and then encoded in base62 to reduce the signature length.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1654, + "module": "_utils", + "name": "create_hmac_signature", + "parsedDocstring": { + "text": "Generate an HMAC-SHA256 signature and encode it using base62.\n\nThe HMAC signature is truncated to 30 characters and then encoded in base62 to reduce the signature length.\n", + "args": { + "secret_key": "The secret key used for signing.", + "message": "The message to be signed.\n" + }, + "returns": "The base62-encoded signature." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 211 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The base62-encoded signature." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Generate an HMAC-SHA256 signature and encode it using base62.\n\nThe HMAC signature is truncated to 30 characters and then encoded in base62 to reduce the signature length.\n" + } + ] + }, + "flags": {}, + "id": 1655, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "create_hmac_signature", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The secret key used for signing." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1656, + "kind": 32768, + "kindString": "Parameter", + "name": "secret_key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The message to be signed.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1657, + "kind": 32768, + "kindString": "Parameter", + "name": "message", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a secure signature for a storage resource like a dataset or key-value store.\n\nThis signature is used to generate a signed URL for authenticated access, which can be expiring or permanent.\nThe signature is created using HMAC with the provided secret key and includes the resource ID, expiration time,\nand version.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1658, + "module": "_utils", + "name": "create_storage_content_signature", + "parsedDocstring": { + "text": "Create a secure signature for a storage resource like a dataset or key-value store.\n\nThis signature is used to generate a signed URL for authenticated access, which can be expiring or permanent.\nThe signature is created using HMAC with the provided secret key and includes the resource ID, expiration time,\nand version.\n", + "args": { + "resource_id": "The unique identifier of the storage resource.", + "url_signing_secret_key": "The secret key for signing the URL.", + "expires_in": "Optional expiration duration; if None, the signature never expires.", + "version": "The signature version number (default: 0).\n" + }, + "returns": "The base64url-encoded signature string." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 230 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The base64url-encoded signature string." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Create a secure signature for a storage resource like a dataset or key-value store.\n\nThis signature is used to generate a signed URL for authenticated access, which can be expiring or permanent.\nThe signature is created using HMAC with the provided secret key and includes the resource ID, expiration time,\nand version.\n" + } + ] + }, + "flags": {}, + "id": 1659, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "create_storage_content_signature", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The unique identifier of the storage resource." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1660, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The secret key for signing the URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1661, + "kind": 32768, + "kindString": "Parameter", + "name": "url_signing_secret_key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional expiration duration; if None, the signature never expires." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1662, + "kind": 32768, + "kindString": "Parameter", + "name": "expires_in", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The signature version number (default: 0).\n" + } + ] + }, + "defaultValue": "0", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1663, + "kind": 32768, + "kindString": "Parameter", + "name": "version", + "type": { + "name": "int", + "type": "reference" + } + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Warn if custom headers override important default headers." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1664, + "module": "_utils", + "name": "check_custom_headers", + "parsedDocstring": { + "text": "Warn if custom headers override important default headers." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 261 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Warn if custom headers override important default headers." + } + ] + }, + "flags": {}, + "id": 1665, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "check_custom_headers", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1666, + "kind": 32768, + "kindString": "Parameter", + "name": "class_name", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1667, + "kind": 32768, + "kindString": "Parameter", + "name": "headers", + "type": { + "name": "dict", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Encode a list of ad-hoc webhooks to a base64 string for the `webhooks` query parameter.\n\nReturns `None` for `None` or an empty list, so the query parameter is omitted.\n\nSee `WebhooksList` for the accepted shapes. `WebhookRepresentation` instances are used as-is; `WebhookCreate`\ninstances are projected onto the `WebhookRepresentation` fields, dropping persistent-only fields like `condition`.\nDict shapes are validated into `WebhookRepresentation` and only fields it declares are kept." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1668, + "module": "_utils", + "name": "encode_webhooks_to_base64", + "parsedDocstring": { + "text": "Encode a list of ad-hoc webhooks to a base64 string for the `webhooks` query parameter.\n\nReturns `None` for `None` or an empty list, so the query parameter is omitted.\n\nSee `WebhooksList` for the accepted shapes. `WebhookRepresentation` instances are used as-is; `WebhookCreate`\ninstances are projected onto the `WebhookRepresentation` fields, dropping persistent-only fields like `condition`.\nDict shapes are validated into `WebhookRepresentation` and only fields it declares are kept." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 286 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Encode a list of ad-hoc webhooks to a base64 string for the `webhooks` query parameter.\n\nReturns `None` for `None` or an empty list, so the query parameter is omitted.\n\nSee `WebhooksList` for the accepted shapes. `WebhookRepresentation` instances are used as-is; `WebhookCreate`\ninstances are projected onto the `WebhookRepresentation` fields, dropping persistent-only fields like `condition`.\nDict shapes are validated into `WebhookRepresentation` and only fields it declares are kept." + } + ] + }, + "flags": {}, + "id": 1669, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "encode_webhooks_to_base64", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1670, + "kind": 32768, + "kindString": "Parameter", + "name": "webhooks", + "type": { + "name": "WebhooksList | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "WebhooksList", + "target": "14" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1672, + "module": "_status_message_watcher", + "name": "__init__", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_status_message_watcher.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 31 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 1673, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1674, + "kind": 32768, + "kindString": "Parameter", + "name": "to_logger", + "type": { + "name": "logging.Logger", + "type": "reference" + } + }, + { + "defaultValue": "timedelta(seconds=5)", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1675, + "kind": 32768, + "kindString": "Parameter", + "name": "check_period", + "type": { + "name": "timedelta", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for polling and logging Actor run status messages." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 1672 + ], + "title": "Methods" + } + ], + "id": 1671, + "module": "_status_message_watcher", + "name": "StatusMessageWatcherBase", + "parsedDocstring": { + "text": "Base class for polling and logging Actor run status messages." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_status_message_watcher.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 22 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "StatusMessageWatcherAsync", + "target": "1676", + "type": "reference" + }, + { + "name": "StatusMessageWatcher", + "target": "1693", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StatusMessageWatcherAsync`.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1677, + "module": "_status_message_watcher", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize `StatusMessageWatcherAsync`.\n", + "args": { + "run_client": "The run client used to poll the Actor run status and status message.", + "to_logger": "The logger to which the status messages will be forwarded.", + "check_period": "How often to poll the status message." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_status_message_watcher.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StatusMessageWatcherAsync`.\n" + } + ] + }, + "flags": {}, + "id": 1678, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The run client used to poll the Actor run status and status message." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1679, + "kind": 32768, + "kindString": "Parameter", + "name": "run_client", + "type": { + "name": "RunClientAsync", + "type": "reference", + "target": "3102" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The logger to which the status messages will be forwarded." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1680, + "kind": 32768, + "kindString": "Parameter", + "name": "to_logger", + "type": { + "name": "logging.Logger", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How often to poll the status message." + } + ] + }, + "defaultValue": "timedelta(seconds=1)", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1681, + "kind": 32768, + "kindString": "Parameter", + "name": "check_period", + "type": { + "name": "timedelta", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "StatusMessageWatcherBase.__init__", + "target": 1672, + "type": "reference" + } + } + ], + "overwrites": { + "name": "StatusMessageWatcherBase.__init__", + "target": 1672, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the polling task.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1682, + "module": "_status_message_watcher", + "name": "start", + "parsedDocstring": { + "text": "Start the polling task.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_status_message_watcher.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 86 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the polling task.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." + } + ] + }, + "flags": {}, + "id": 1683, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "start", + "parameters": [], + "type": { + "name": "Task", + "type": "reference", + "target": "1197" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stop the logging task." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1684, + "module": "_status_message_watcher", + "name": "stop", + "parsedDocstring": { + "text": "Stop the logging task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_status_message_watcher.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 96 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stop the logging task." + } + ] + }, + "flags": {}, + "id": 1685, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "stop", + "parameters": [], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the logging task within the context. Exiting the context will cancel the logging task." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1686, + "module": "_status_message_watcher", + "name": "__aenter__", + "parsedDocstring": { + "text": "Start the logging task within the context. Exiting the context will cancel the logging task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_status_message_watcher.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 109 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the logging task within the context. Exiting the context will cancel the logging task." + } + ] + }, + "flags": {}, + "id": 1687, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "__aenter__", + "parameters": [], + "type": { + "name": "Self", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Cancel the logging task." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1688, + "module": "_status_message_watcher", + "name": "__aexit__", + "parsedDocstring": { + "text": "Cancel the logging task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_status_message_watcher.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 114 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Cancel the logging task." + } + ] + }, + "flags": {}, + "id": 1689, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "__aexit__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1690, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_type", + "type": { + "name": "type[BaseException] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "type", + "typeArguments": [ + { + "type": "reference", + "name": "BaseException" + } + ], + "target": "474" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1691, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_val", + "type": { + "name": "BaseException | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "BaseException" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1692, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_tb", + "type": { + "name": "TracebackType | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "TracebackType" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Polls and logs Actor run status messages in an asyncio task.\n\nThe status message and status of the Actor run are polled at a fixed interval and forwarded to the provided logger\nwhenever they change. There is no guarantee that every intermediate status message will be captured, especially\nwhen messages change rapidly.\n\nCan be used as an async context manager, which automatically starts and cancels the polling task. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClientAsync.get_status_message_watcher`." + } + ] + }, + "decorations": [ + { + "args": "('Other')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1686, + 1688, + 1677, + 1682, + 1684 + ], + "title": "Methods" + } + ], + "id": 1676, + "module": "_status_message_watcher", + "name": "StatusMessageWatcherAsync", + "parsedDocstring": { + "text": "Polls and logs Actor run status messages in an asyncio task.\n\nThe status message and status of the Actor run are polled at a fixed interval and forwarded to the provided logger\nwhenever they change. There is no guarantee that every intermediate status message will be captured, especially\nwhen messages change rapidly.\n\nCan be used as an async context manager, which automatically starts and cancels the polling task. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClientAsync.get_status_message_watcher`." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_status_message_watcher.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 61 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "StatusMessageWatcherBase", + "target": "1671", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StatusMessageWatcher`.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1694, + "module": "_status_message_watcher", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize `StatusMessageWatcher`.\n", + "args": { + "run_client": "The run client used to poll the Actor run status and status message.", + "to_logger": "The logger to which the status messages will be forwarded.", + "check_period": "How often to poll the status message." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_status_message_watcher.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 142 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize `StatusMessageWatcher`.\n" + } + ] + }, + "flags": {}, + "id": 1695, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The run client used to poll the Actor run status and status message." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1696, + "kind": 32768, + "kindString": "Parameter", + "name": "run_client", + "type": { + "name": "RunClient", + "type": "reference", + "target": "3033" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The logger to which the status messages will be forwarded." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1697, + "kind": 32768, + "kindString": "Parameter", + "name": "to_logger", + "type": { + "name": "logging.Logger", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How often to poll the status message." + } + ] + }, + "defaultValue": "timedelta(seconds=1)", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1698, + "kind": 32768, + "kindString": "Parameter", + "name": "check_period", + "type": { + "name": "timedelta", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "StatusMessageWatcherBase.__init__", + "target": 1672, + "type": "reference" + } + } + ], + "overwrites": { + "name": "StatusMessageWatcherBase.__init__", + "target": 1672, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the polling thread.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1699, + "module": "_status_message_watcher", + "name": "start", + "parsedDocstring": { + "text": "Start the polling thread.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_status_message_watcher.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 157 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the polling thread.\n\nThe caller is responsible for cleanup by calling the `stop` method when done." + } + ] + }, + "flags": {}, + "id": 1700, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "start", + "parameters": [], + "type": { + "name": "Thread", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signal the logging thread to stop logging and wait for it to finish." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1701, + "module": "_status_message_watcher", + "name": "stop", + "parsedDocstring": { + "text": "Signal the logging thread to stop logging and wait for it to finish." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_status_message_watcher.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 169 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signal the logging thread to stop logging and wait for it to finish." + } + ] + }, + "flags": {}, + "id": 1702, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "stop", + "parameters": [], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the logging thread within the context. Exiting the context will stop the logging thread." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1703, + "module": "_status_message_watcher", + "name": "__enter__", + "parsedDocstring": { + "text": "Start the logging thread within the context. Exiting the context will stop the logging thread." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_status_message_watcher.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 178 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the logging thread within the context. Exiting the context will stop the logging thread." + } + ] + }, + "flags": {}, + "id": 1704, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__enter__", + "parameters": [], + "type": { + "name": "Self", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stop the logging thread." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1705, + "module": "_status_message_watcher", + "name": "__exit__", + "parsedDocstring": { + "text": "Stop the logging thread." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_status_message_watcher.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 183 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stop the logging thread." + } + ] + }, + "flags": {}, + "id": 1706, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__exit__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1707, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_type", + "type": { + "name": "type[BaseException] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "type", + "typeArguments": [ + { + "type": "reference", + "name": "BaseException" + } + ], + "target": "474" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1708, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_val", + "type": { + "name": "BaseException | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "BaseException" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1709, + "kind": 32768, + "kindString": "Parameter", + "name": "exc_tb", + "type": { + "name": "TracebackType | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "TracebackType" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Polls and logs Actor run status messages in a background thread.\n\nThe status message and status of the Actor run are polled at a fixed interval and forwarded to the provided logger\nwhenever they change. There is no guarantee that every intermediate status message will be captured, especially\nwhen messages change rapidly.\n\nCan be used as a context manager, which automatically starts and stops the polling thread. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClient.get_status_message_watcher`." + } + ] + }, + "decorations": [ + { + "args": "('Other')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1703, + 1705, + 1694, + 1699, + 1701 + ], + "title": "Methods" + } + ], + "id": 1693, + "module": "_status_message_watcher", + "name": "StatusMessageWatcher", + "parsedDocstring": { + "text": "Polls and logs Actor run status messages in a background thread.\n\nThe status message and status of the Actor run are polled at a fixed interval and forwarded to the provided logger\nwhenever they change. There is no guarantee that every intermediate status message will be captured, especially\nwhen messages change rapidly.\n\nCan be used as a context manager, which automatically starts and stops the polling thread. Alternatively,\ncall `start` and `stop` manually. Obtain an instance via `RunClient.get_status_message_watcher`." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_status_message_watcher.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 131 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "StatusMessageWatcherBase", + "target": "1671", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1711, + "module": "_client_registry", + "name": "actor_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 73 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorClient", + "target": "3404" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1712, + "module": "_client_registry", + "name": "actor_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 74 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorCollectionClient", + "target": "2262" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1713, + "module": "_client_registry", + "name": "actor_env_var_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 75 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorEnvVarClient", + "target": "3758" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1714, + "module": "_client_registry", + "name": "actor_env_var_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 76 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorEnvVarCollectionClient", + "target": "2194" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1715, + "module": "_client_registry", + "name": "actor_version_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 77 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorVersionClient", + "target": "2424" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1716, + "module": "_client_registry", + "name": "actor_version_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 78 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorVersionCollectionClient", + "target": "3275" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1717, + "module": "_client_registry", + "name": "build_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 79 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "BuildClient", + "target": "3171" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1718, + "module": "_client_registry", + "name": "build_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 80 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "BuildCollectionClient", + "target": "2778" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1719, + "module": "_client_registry", + "name": "dataset_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 81 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "DatasetClient", + "target": "2819" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1720, + "module": "_client_registry", + "name": "dataset_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 82 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "DatasetCollectionClient", + "target": "3321" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1721, + "module": "_client_registry", + "name": "key_value_store_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 83 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "KeyValueStoreClient", + "target": "3608" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1722, + "module": "_client_registry", + "name": "key_value_store_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 84 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "KeyValueStoreCollectionClient", + "target": "2372" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1723, + "module": "_client_registry", + "name": "log_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 85 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "LogClient", + "target": "2160" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1724, + "module": "_client_registry", + "name": "request_queue_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 86 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "RequestQueueClient", + "target": "1996" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1725, + "module": "_client_registry", + "name": "request_queue_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 87 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "RequestQueueCollectionClient", + "target": "2480" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1726, + "module": "_client_registry", + "name": "run_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 88 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "RunClient", + "target": "3033" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1727, + "module": "_client_registry", + "name": "run_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 89 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "RunCollectionClient", + "target": "3916" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1728, + "module": "_client_registry", + "name": "schedule_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 90 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ScheduleClient", + "target": "1904" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1729, + "module": "_client_registry", + "name": "schedule_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 91 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ScheduleCollectionClient", + "target": "3219" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1730, + "module": "_client_registry", + "name": "store_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 92 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "StoreCollectionClient", + "target": "2598" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1731, + "module": "_client_registry", + "name": "task_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 93 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "TaskClient", + "target": "2648" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1732, + "module": "_client_registry", + "name": "task_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 94 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "TaskCollectionClient", + "target": "2530" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1733, + "module": "_client_registry", + "name": "user_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 95 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "UserClient", + "target": "1956" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1734, + "module": "_client_registry", + "name": "webhook_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 96 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookClient", + "target": "3856" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1735, + "module": "_client_registry", + "name": "webhook_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 97 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookCollectionClient", + "target": "3794" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1736, + "module": "_client_registry", + "name": "webhook_dispatch_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 98 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookDispatchClient", + "target": "2354" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1737, + "module": "_client_registry", + "name": "webhook_dispatch_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 99 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookDispatchCollectionClient", + "target": "2228" + } + ], + "target": "474" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of all sync client classes for dependency injection.\n\nThis config object is passed to the resource clients to avoid circular dependencies. Each resource client\nreceives this config and can instantiate other clients as needed." + } + ] + }, + "decorations": [ + { + "name": "dataclass" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1711, + 1712, + 1713, + 1714, + 1715, + 1716, + 1717, + 1718, + 1719, + 1720, + 1721, + 1722, + 1723, + 1724, + 1725, + 1726, + 1727, + 1728, + 1729, + 1730, + 1731, + 1732, + 1733, + 1734, + 1735, + 1736, + 1737 + ], + "title": "Properties" + } + ], + "id": 1710, + "module": "_client_registry", + "name": "ClientRegistry", + "parsedDocstring": { + "text": "Bundle of all sync client classes for dependency injection.\n\nThis config object is passed to the resource clients to avoid circular dependencies. Each resource client\nreceives this config and can instantiate other clients as needed." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 66 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1739, + "module": "_client_registry", + "name": "actor_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 110 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorClientAsync", + "target": "3506" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1740, + "module": "_client_registry", + "name": "actor_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 111 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorCollectionClientAsync", + "target": "2308" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1741, + "module": "_client_registry", + "name": "actor_env_var_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 112 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorEnvVarClientAsync", + "target": "3776" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1742, + "module": "_client_registry", + "name": "actor_env_var_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 113 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorEnvVarCollectionClientAsync", + "target": "2211" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1743, + "module": "_client_registry", + "name": "actor_version_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 114 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorVersionClientAsync", + "target": "2452" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1744, + "module": "_client_registry", + "name": "actor_version_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 115 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorVersionCollectionClientAsync", + "target": "3298" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1745, + "module": "_client_registry", + "name": "build_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 116 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "BuildClientAsync", + "target": "3195" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1746, + "module": "_client_registry", + "name": "build_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 117 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "BuildCollectionClientAsync", + "target": "2795" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1747, + "module": "_client_registry", + "name": "dataset_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 118 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "DatasetClientAsync", + "target": "2926" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1748, + "module": "_client_registry", + "name": "dataset_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 119 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "DatasetCollectionClientAsync", + "target": "3347" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1749, + "module": "_client_registry", + "name": "key_value_store_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 120 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "KeyValueStoreClientAsync", + "target": "3683" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1750, + "module": "_client_registry", + "name": "key_value_store_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 121 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "KeyValueStoreCollectionClientAsync", + "target": "2398" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1751, + "module": "_client_registry", + "name": "log_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 122 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "LogClientAsync", + "target": "2177" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1752, + "module": "_client_registry", + "name": "request_queue_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 123 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "RequestQueueClientAsync", + "target": "2078" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1753, + "module": "_client_registry", + "name": "request_queue_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 124 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "RequestQueueCollectionClientAsync", + "target": "2505" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1754, + "module": "_client_registry", + "name": "run_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 125 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "RunClientAsync", + "target": "3102" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1755, + "module": "_client_registry", + "name": "run_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 126 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "RunCollectionClientAsync", + "target": "3939" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1756, + "module": "_client_registry", + "name": "schedule_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 127 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ScheduleClientAsync", + "target": "1930" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1757, + "module": "_client_registry", + "name": "schedule_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 128 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ScheduleCollectionClientAsync", + "target": "3247" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1758, + "module": "_client_registry", + "name": "store_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 129 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "StoreCollectionClientAsync", + "target": "2623" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1759, + "module": "_client_registry", + "name": "task_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 130 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "TaskClientAsync", + "target": "2713" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1760, + "module": "_client_registry", + "name": "task_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 131 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "TaskCollectionClientAsync", + "target": "2564" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1761, + "module": "_client_registry", + "name": "user_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 132 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "UserClientAsync", + "target": "1976" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1762, + "module": "_client_registry", + "name": "webhook_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 133 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookClientAsync", + "target": "3886" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1763, + "module": "_client_registry", + "name": "webhook_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 134 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookCollectionClientAsync", + "target": "3825" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1764, + "module": "_client_registry", + "name": "webhook_dispatch_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 135 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookDispatchClientAsync", + "target": "2363" + } + ], + "target": "474" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1765, + "module": "_client_registry", + "name": "webhook_dispatch_collection_client", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 136 + } + ], + "type": { + "name": "type", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookDispatchCollectionClientAsync", + "target": "2245" + } + ], + "target": "474" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of all async client classes for dependency injection.\n\nThis config object is passed to the resource clients to avoid circular dependencies. Each resource client\nreceives this config and can instantiate other clients as needed." + } + ] + }, + "decorations": [ + { + "name": "dataclass" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1739, + 1740, + 1741, + 1742, + 1743, + 1744, + 1745, + 1746, + 1747, + 1748, + 1749, + 1750, + 1751, + 1752, + 1753, + 1754, + 1755, + 1756, + 1757, + 1758, + 1759, + 1760, + 1761, + 1762, + 1763, + 1764, + 1765 + ], + "title": "Properties" + } + ], + "id": 1738, + "module": "_client_registry", + "name": "ClientRegistryAsync", + "parsedDocstring": { + "text": "Bundle of all async client classes for dependency injection.\n\nThis config object is passed to the resource clients to avoid circular dependencies. Each resource client\nreceives this config and can instantiate other clients as needed." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_client_registry.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 103 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1766, + "module": "_pagination", + "name": "T", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_pagination.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 10 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default per-page size used by the iterate helpers when the caller does not specify one.\n\nThe value of 1000 keeps backwards compatibility with the previous fixed cache size." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1767, + "module": "_pagination", + "name": "DEFAULT_CHUNK_SIZE", + "parsedDocstring": { + "text": "Default per-page size used by the iterate helpers when the caller does not specify one.\n\nThe value of 1000 keeps backwards compatibility with the previous fixed cache size." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_pagination.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 12 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1769, + "module": "_pagination", + "name": "items", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_pagination.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 27 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "T", + "target": "9" + } + ], + "target": "2199" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Structural contract for a single page of results from a paginated API endpoint.\n\nImplementations must expose `items`. They may optionally expose `count` — the number of items scanned by the API for\nthis page, which can exceed `len(items)` when filters drop items from the response. The iterator helpers consult\n`count` opportunistically via `getattr` for offset bookkeeping and fall back to `len(items)` when it is absent." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 1769 + ], + "title": "Properties" + } + ], + "id": 1768, + "module": "_pagination", + "name": "HasItems", + "parsedDocstring": { + "text": "Structural contract for a single page of results from a paginated API endpoint.\n\nImplementations must expose `items`. They may optionally expose `count` — the number of items scanned by the API for\nthis page, which can exceed `len(items)` when filters drop items from the response. The iterator helpers consult\n`count` opportunistically via `getattr` for offset bookkeeping and fall back to `len(items)` when it is absent." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_pagination.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 19 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Yield individual items from offset-based paginated API responses.\n\nThe `callback` is invoked lazily to fetch each page from the API. It must accept `limit` and `offset` keyword\narguments and return an object whose `items` attribute is a list. If the object also exposes a `count` attribute, it\nis used for offset bookkeeping (the Apify API's `count` reflects items scanned, which can exceed items returned when\nfilters are applied).\n\nIteration stops when a page returns no items or when the user-requested `limit` is reached. The `total` field is\nintentionally not consulted, because it can change between calls.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1770, + "module": "_pagination", + "name": "get_items_iterator", + "parsedDocstring": { + "text": "Yield individual items from offset-based paginated API responses.\n\nThe `callback` is invoked lazily to fetch each page from the API. It must accept `limit` and `offset` keyword\narguments and return an object whose `items` attribute is a list. If the object also exposes a `count` attribute, it\nis used for offset bookkeeping (the Apify API's `count` reflects items scanned, which can exceed items returned when\nfilters are applied).\n\nIteration stops when a page returns no items or when the user-requested `limit` is reached. The `total` field is\nintentionally not consulted, because it can change between calls.\n", + "args": { + "callback": "Function returning a single page of items.", + "limit": "Maximum total number of items to yield across all pages. `None` or `0` means no limit.", + "offset": "Starting offset for the first page.", + "chunk_size": "Maximum number of items requested per API call. `None` or `0` lets the API decide." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_pagination.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 30 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Yield individual items from offset-based paginated API responses.\n\nThe `callback` is invoked lazily to fetch each page from the API. It must accept `limit` and `offset` keyword\narguments and return an object whose `items` attribute is a list. If the object also exposes a `count` attribute, it\nis used for offset bookkeeping (the Apify API's `count` reflects items scanned, which can exceed items returned when\nfilters are applied).\n\nIteration stops when a page returns no items or when the user-requested `limit` is reached. The `total` field is\nintentionally not consulted, because it can change between calls.\n" + } + ] + }, + "flags": {}, + "id": 1771, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_items_iterator", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Function returning a single page of items." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1772, + "kind": 32768, + "kindString": "Parameter", + "name": "callback", + "type": { + "name": "Callable", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "..." + }, + { + "type": "reference", + "name": "HasItems", + "typeArguments": [ + { + "type": "reference", + "name": "T", + "target": "9" + } + ], + "target": "1768" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum total number of items to yield across all pages. `None` or `0` means no limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1773, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Starting offset for the first page." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1774, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of items requested per API call. `None` or `0` lets the API decide." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1775, + "kind": 32768, + "kindString": "Parameter", + "name": "chunk_size", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "T", + "target": "9" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async variant of :func:`get_items_iterator`.\n\nThe `callback` must be an awaitable returning a single page of items." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1776, + "module": "_pagination", + "name": "get_items_iterator_async", + "parsedDocstring": { + "text": "Async variant of :func:`get_items_iterator`.\n\nThe `callback` must be an awaitable returning a single page of items." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_pagination.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 71 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async variant of :func:`get_items_iterator`.\n\nThe `callback` must be an awaitable returning a single page of items." + } + ] + }, + "flags": {}, + "id": 1777, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_items_iterator_async", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1778, + "kind": 32768, + "kindString": "Parameter", + "name": "callback", + "type": { + "name": "Callable", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "..." + }, + { + "type": "reference", + "name": "Awaitable", + "typeArguments": [ + { + "type": "reference", + "name": "HasItems", + "typeArguments": [ + { + "type": "reference", + "name": "T", + "target": "9" + } + ], + "target": "1768" + } + ] + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1779, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1780, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1781, + "kind": 32768, + "kindString": "Parameter", + "name": "chunk_size", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "T", + "target": "9" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Yield individual items from cursor-paginated API responses.\n\nCursor pagination is restricted to the two API responses that expose it: `ListOfKeys` (for key-value store keys) and\n`ListOfRequests` (for request queue requests). Iteration ends when a page returns no items, the next cursor is\n`None`, or the user-requested `limit` is reached.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1782, + "module": "_pagination", + "name": "get_cursor_iterator", + "parsedDocstring": { + "text": "Yield individual items from cursor-paginated API responses.\n\nCursor pagination is restricted to the two API responses that expose it: `ListOfKeys` (for key-value store keys) and\n`ListOfRequests` (for request queue requests). Iteration ends when a page returns no items, the next cursor is\n`None`, or the user-requested `limit` is reached.\n", + "args": { + "callback": "Function returning a single page of items. Receives `cursor` and `limit` kwargs.", + "cursor": "Value of the cursor for the first request, or `None` to start from the beginning.", + "limit": "Maximum total number of items to yield across all pages.", + "chunk_size": "Maximum number of items requested per API call." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_pagination.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 117 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Yield individual items from cursor-paginated API responses.\n\nCursor pagination is restricted to the two API responses that expose it: `ListOfKeys` (for key-value store keys) and\n`ListOfRequests` (for request queue requests). Iteration ends when a page returns no items, the next cursor is\n`None`, or the user-requested `limit` is reached.\n" + } + ] + }, + "flags": {}, + "id": 1783, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_cursor_iterator", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Function returning a single page of items. Receives `cursor` and `limit` kwargs." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1784, + "kind": 32768, + "kindString": "Parameter", + "name": "callback", + "type": { + "name": "Callable", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "..." + }, + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "ListOfKeys", + "target": "667" + }, + { + "type": "reference", + "name": "ListOfRequests", + "target": "681" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Value of the cursor for the first request, or `None` to start from the beginning." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1785, + "kind": 32768, + "kindString": "Parameter", + "name": "cursor", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum total number of items to yield across all pages." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1786, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of items requested per API call." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1787, + "kind": 32768, + "kindString": "Parameter", + "name": "chunk_size", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "Iterator[KeyValueStoreKey] | Iterator[Request]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Iterator", + "typeArguments": [ + { + "type": "reference", + "name": "KeyValueStoreKey", + "target": "611" + } + ] + }, + { + "type": "reference", + "name": "Iterator", + "typeArguments": [ + { + "type": "reference", + "name": "Request", + "target": "876" + } + ] + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async variant of :func:`get_cursor_iterator`." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1788, + "module": "_pagination", + "name": "get_cursor_iterator_async", + "parsedDocstring": { + "text": "Async variant of :func:`get_cursor_iterator`." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_pagination.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 172 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Async variant of :func:`get_cursor_iterator`." + } + ] + }, + "flags": {}, + "id": 1789, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_cursor_iterator_async", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 1790, + "kind": 32768, + "kindString": "Parameter", + "name": "callback", + "type": { + "name": "Callable", + "type": "reference", + "typeArguments": [ + { + "type": "literal", + "value": "..." + }, + { + "type": "reference", + "name": "Awaitable", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "ListOfKeys", + "target": "667" + }, + { + "type": "reference", + "name": "ListOfRequests", + "target": "681" + } + ] + } + ] + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1791, + "kind": 32768, + "kindString": "Parameter", + "name": "cursor", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1792, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1793, + "kind": 32768, + "kindString": "Parameter", + "name": "chunk_size", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "AsyncIterator[KeyValueStoreKey] | AsyncIterator[Request]", + "type": "union", + "types": [ + { + "type": "reference", + "name": "AsyncIterator", + "typeArguments": [ + { + "type": "reference", + "name": "KeyValueStoreKey", + "target": "611" + } + ] + }, + { + "type": "reference", + "name": "AsyncIterator", + "typeArguments": [ + { + "type": "reference", + "name": "Request", + "target": "876" + } + ] + } + ] + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Status of an Actor job (run or build)." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1794, + "module": "_literals", + "name": "ActorJobStatus", + "parsedDocstring": { + "text": "Status of an Actor job (run or build)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_literals.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 7 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Determines permissions that the Actor requires to run. For more information, see the [Actor permissions documentation](https://docs.apify.com/platform/actors/development/permissions)." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1795, + "module": "_literals", + "name": "ActorPermissionLevel", + "parsedDocstring": { + "text": "Determines permissions that the Actor requires to run. For more information, see the [Actor permissions documentation](https://docs.apify.com/platform/actors/development/permissions)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_literals.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 20 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Machine-processable error type identifier." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1796, + "module": "_literals", + "name": "ErrorType", + "parsedDocstring": { + "text": "Machine-processable error type identifier." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_literals.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 27 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Defines the general access level for the resource." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1797, + "module": "_literals", + "name": "GeneralAccess", + "parsedDocstring": { + "text": "Defines the general access level for the resource." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_literals.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 421 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1798, + "module": "_literals", + "name": "HttpMethod", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_literals.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 430 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1799, + "module": "_literals", + "name": "RunOrigin", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_literals.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 443 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1800, + "module": "_literals", + "name": "SourceCodeFileFormat", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_literals.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 456 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1801, + "module": "_literals", + "name": "StorageOwnership", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_literals.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 462 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1802, + "module": "_literals", + "name": "VersionSourceType", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_literals.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 468 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Status of the webhook dispatch indicating whether the HTTP request was successful." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1803, + "module": "_literals", + "name": "WebhookDispatchStatus", + "parsedDocstring": { + "text": "Status of the webhook dispatch indicating whether the HTTP request was successful." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_literals.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 476 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Type of event that triggers the webhook." + } + ] + }, + "flags": {}, + "groups": [], + "id": 1804, + "module": "_literals", + "name": "WebhookEventType", + "parsedDocstring": { + "text": "Type of event that triggers the webhook." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_literals.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 484 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP status code of the response." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 1806, + "module": "http_clients._base", + "name": "status_code", + "parsedDocstring": { + "text": "HTTP status code of the response." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 42 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response body decoded as text." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 1807, + "module": "http_clients._base", + "name": "text", + "parsedDocstring": { + "text": "Response body decoded as text." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 46 + } + ], + "type": { + "name": "str", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Raw response body as bytes." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 1808, + "module": "http_clients._base", + "name": "content", + "parsedDocstring": { + "text": "Raw response body as bytes." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 50 + } + ], + "type": { + "name": "bytes", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Response headers as a mapping." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 1809, + "module": "http_clients._base", + "name": "headers", + "parsedDocstring": { + "text": "Response headers as a mapping." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 54 + } + ], + "type": { + "name": "Mapping", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parse response body as JSON." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1810, + "module": "http_clients._base", + "name": "json", + "parsedDocstring": { + "text": "Parse response body as JSON." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 57 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parse response body as JSON." + } + ] + }, + "flags": {}, + "id": 1811, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "json", + "parameters": [], + "type": { + "name": "Any", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Read the entire response body." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1812, + "module": "http_clients._base", + "name": "read", + "parsedDocstring": { + "text": "Read the entire response body." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 60 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Read the entire response body." + } + ] + }, + "flags": {}, + "id": 1813, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "read", + "parameters": [], + "type": { + "name": "bytes", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Read the entire response body asynchronously." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1814, + "module": "http_clients._base", + "name": "aread", + "parsedDocstring": { + "text": "Read the entire response body asynchronously." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 63 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Read the entire response body asynchronously." + } + ] + }, + "flags": {}, + "id": 1815, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "aread", + "parameters": [], + "type": { + "name": "bytes", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Close the response and release the connection." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1816, + "module": "http_clients._base", + "name": "close", + "parsedDocstring": { + "text": "Close the response and release the connection." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 66 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Close the response and release the connection." + } + ] + }, + "flags": {}, + "id": 1817, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "close", + "parameters": [], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Close the response and release the connection asynchronously." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1818, + "module": "http_clients._base", + "name": "aclose", + "parsedDocstring": { + "text": "Close the response and release the connection asynchronously." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 69 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Close the response and release the connection asynchronously." + } + ] + }, + "flags": {}, + "id": 1819, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "aclose", + "parameters": [], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the response body in bytes chunks." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1820, + "module": "http_clients._base", + "name": "iter_bytes", + "parsedDocstring": { + "text": "Iterate over the response body in bytes chunks." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the response body in bytes chunks." + } + ] + }, + "flags": {}, + "id": 1821, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iter_bytes", + "parameters": [], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bytes" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the response body in bytes chunks asynchronously." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1822, + "module": "http_clients._base", + "name": "aiter_bytes", + "parsedDocstring": { + "text": "Iterate over the response body in bytes chunks asynchronously." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 75 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the response body in bytes chunks asynchronously." + } + ] + }, + "flags": {}, + "id": 1823, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "aiter_bytes", + "parameters": [], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bytes" + } + ] + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Protocol for HTTP response objects returned by HTTP clients.\n\nAny object that has the required attributes and methods can be used as an HTTP response\n(e.g., `impit.Response`). This enables custom HTTP client implementations to return\ntheir own response types." + } + ] + }, + "decorations": [ + { + "args": "('HTTP clients')", + "name": "docs_group" + }, + { + "name": "runtime_checkable" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1818, + 1822, + 1814, + 1816, + 1820, + 1810, + 1812 + ], + "title": "Methods" + }, + { + "children": [ + 1808, + 1809, + 1806, + 1807 + ], + "title": "Properties" + } + ], + "id": 1805, + "module": "http_clients._base", + "name": "HttpResponse", + "parsedDocstring": { + "text": "Protocol for HTTP response objects returned by HTTP clients.\n\nAny object that has the required attributes and methods can be used as an HTTP response\n(e.g., `impit.Response`). This enables custom HTTP client implementations to return\ntheir own response types." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 33 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the HTTP client base.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1825, + "module": "http_clients._base", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the HTTP client base.\n", + "args": { + "token": "Apify API token for authentication.", + "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).", + "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).", + "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).", + "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.", + "max_retries": "Maximum number of retries for failed requests.", + "min_delay_between_retries": "Minimum delay between retries.", + "statistics": "Statistics tracker for API calls. Created automatically if not provided.", + "headers": "Additional HTTP headers to include in all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 91 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the HTTP client base.\n" + } + ] + }, + "flags": {}, + "id": 1826, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Apify API token for authentication." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1827, + "kind": 32768, + "kindString": "Parameter", + "name": "token", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_SHORT", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1828, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_short", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_MEDIUM", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1829, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_medium", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_LONG", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1830, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_long", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum timeout cap for exponential timeout growth across retries." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_MAX", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1831, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_max", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of retries for failed requests." + } + ] + }, + "defaultValue": "DEFAULT_MAX_RETRIES", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1832, + "kind": 32768, + "kindString": "Parameter", + "name": "max_retries", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Minimum delay between retries." + } + ] + }, + "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1833, + "kind": 32768, + "kindString": "Parameter", + "name": "min_delay_between_retries", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statistics tracker for API calls. Created automatically if not provided." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1834, + "kind": 32768, + "kindString": "Parameter", + "name": "statistics", + "type": { + "name": "ClientStatistics | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ClientStatistics", + "target": "1" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Additional HTTP headers to include in all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1835, + "kind": 32768, + "kindString": "Parameter", + "name": "headers", + "type": { + "name": "dict[str, str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "str" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Shared configuration and utilities for HTTP clients.\n\nProvides common functionality for both sync and async HTTP clients including:\nheader construction, parameter parsing, request body preparation, URL building,\nand timeout calculation.\n\nSubclasses should call `super().__init__()` to initialize shared configuration.\nThe helper methods are then available for use in the `call()` implementation." + } + ] + }, + "decorations": [ + { + "args": "('HTTP clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1825 + ], + "title": "Methods" + } + ], + "id": 1824, + "module": "http_clients._base", + "name": "HttpClientBase", + "parsedDocstring": { + "text": "Shared configuration and utilities for HTTP clients.\n\nProvides common functionality for both sync and async HTTP clients including:\nheader construction, parameter parsing, request body preparation, URL building,\nand timeout calculation.\n\nSubclasses should call `super().__init__()` to initialize shared configuration.\nThe helper methods are then available for use in the `call()` implementation." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 80 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "HttpClient", + "target": "1836", + "type": "reference" + }, + { + "name": "HttpClientAsync", + "target": "1847", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Make an HTTP request.\n" + } + ] + }, + "decorations": [ + { + "name": "abstractmethod" + } + ], + "flags": {}, + "groups": [], + "id": 1837, + "module": "http_clients._base", + "name": "call", + "parsedDocstring": { + "text": "Make an HTTP request.\n", + "args": { + "method": "HTTP method (GET, POST, PUT, DELETE, etc.).", + "url": "Full URL to make the request to.", + "headers": "Additional headers to include in this request.", + "params": "Query parameters to append to the URL.", + "data": "Raw request body data. Cannot be used together with json.", + "json": "JSON-serializable data for the request body. Cannot be used together with data.", + "stream": "Whether to stream the response body.", + "timeout": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n" + }, + "returns": "The HTTP response object." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 252 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The HTTP response object." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Make an HTTP request.\n" + } + ] + }, + "flags": {}, + "id": 1838, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "call", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP method (GET, POST, PUT, DELETE, etc.)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1839, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Full URL to make the request to." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1840, + "kind": 32768, + "kindString": "Parameter", + "name": "url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Additional headers to include in this request." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1841, + "kind": 32768, + "kindString": "Parameter", + "name": "headers", + "type": { + "name": "dict[str, str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "str" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Query parameters to append to the URL." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1842, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict[str, Any] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Raw request body data. Cannot be used together with json." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1843, + "kind": 32768, + "kindString": "Parameter", + "name": "data", + "type": { + "name": "str | bytes | bytearray | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "bytes" + } + ] + }, + { + "type": "reference", + "name": "bytearray" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "JSON-serializable data for the request body. Cannot be used together with data." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1844, + "kind": 32768, + "kindString": "Parameter", + "name": "json", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to stream the response body." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1845, + "kind": 32768, + "kindString": "Parameter", + "name": "stream", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1846, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the HTTP client base.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 4018, + "module": "http_clients._base", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the HTTP client base.\n", + "args": { + "token": "Apify API token for authentication.", + "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).", + "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).", + "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).", + "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.", + "max_retries": "Maximum number of retries for failed requests.", + "min_delay_between_retries": "Minimum delay between retries.", + "statistics": "Statistics tracker for API calls. Created automatically if not provided.", + "headers": "Additional HTTP headers to include in all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 91 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the HTTP client base.\n" + } + ] + }, + "flags": {}, + "id": 1826, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Apify API token for authentication." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1827, + "kind": 32768, + "kindString": "Parameter", + "name": "token", + "type": { + "name": "str | None", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_SHORT", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1828, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_short", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_MEDIUM", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1829, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_medium", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_LONG", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1830, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_long", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum timeout cap for exponential timeout growth across retries." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_MAX", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1831, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_max", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of retries for failed requests." + } + ] + }, + "defaultValue": "DEFAULT_MAX_RETRIES", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1832, + "kind": 32768, + "kindString": "Parameter", + "name": "max_retries", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Minimum delay between retries." + } + ] + }, + "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1833, + "kind": 32768, + "kindString": "Parameter", + "name": "min_delay_between_retries", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statistics tracker for API calls. Created automatically if not provided." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1834, + "kind": 32768, + "kindString": "Parameter", + "name": "statistics", + "type": { + "name": "ClientStatistics | None", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Additional HTTP headers to include in all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1835, + "kind": 32768, + "kindString": "Parameter", + "name": "headers", + "type": { + "name": "dict[str, str] | None", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "reference" + }, + "inheritedFrom": { + "name": "HttpClientBase.__init__", + "target": 1825, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "HttpClientBase.__init__", + "target": 1825, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Abstract base class for synchronous HTTP clients used by `ApifyClient`.\n\nExtend this class to create a custom synchronous HTTP client. Override the `call` method\nwith your implementation. Helper methods from the base class are available for request\npreparation, URL building, and parameter parsing." + } + ] + }, + "decorations": [ + { + "args": "('HTTP clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4018, + 1837 + ], + "title": "Methods" + } + ], + "id": 1836, + "module": "http_clients._base", + "name": "HttpClient", + "parsedDocstring": { + "text": "Abstract base class for synchronous HTTP clients used by `ApifyClient`.\n\nExtend this class to create a custom synchronous HTTP client. Override the `call` method\nwith your implementation. Helper methods from the base class are available for request\npreparation, URL building, and parameter parsing." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 243 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "HttpClientBase", + "target": "1824", + "type": "reference" + } + ], + "extendedBy": [ + { + "name": "ImpitHttpClient", + "target": "1860", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Make an HTTP request.\n" + } + ] + }, + "decorations": [ + { + "name": "abstractmethod" + } + ], + "flags": {}, + "groups": [], + "id": 1848, + "module": "http_clients._base", + "name": "call", + "parsedDocstring": { + "text": "Make an HTTP request.\n", + "args": { + "method": "HTTP method (GET, POST, PUT, DELETE, etc.).", + "url": "Full URL to make the request to.", + "headers": "Additional headers to include in this request.", + "params": "Query parameters to append to the URL.", + "data": "Raw request body data. Cannot be used together with json.", + "json": "JSON-serializable data for the request body. Cannot be used together with data.", + "stream": "Whether to stream the response body.", + "timeout": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n" + }, + "returns": "The HTTP response object." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 296 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The HTTP response object." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Make an HTTP request.\n" + } + ] + }, + "flags": {}, + "id": 1849, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "call", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP method (GET, POST, PUT, DELETE, etc.)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1850, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Full URL to make the request to." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1851, + "kind": 32768, + "kindString": "Parameter", + "name": "url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Additional headers to include in this request." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1852, + "kind": 32768, + "kindString": "Parameter", + "name": "headers", + "type": { + "name": "dict[str, str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "str" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Query parameters to append to the URL." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1853, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict[str, Any] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Raw request body data. Cannot be used together with json." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1854, + "kind": 32768, + "kindString": "Parameter", + "name": "data", + "type": { + "name": "str | bytes | bytearray | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "bytes" + } + ] + }, + { + "type": "reference", + "name": "bytearray" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "JSON-serializable data for the request body. Cannot be used together with data." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1855, + "kind": 32768, + "kindString": "Parameter", + "name": "json", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to stream the response body." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1856, + "kind": 32768, + "kindString": "Parameter", + "name": "stream", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1857, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the HTTP client base.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 4019, + "module": "http_clients._base", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the HTTP client base.\n", + "args": { + "token": "Apify API token for authentication.", + "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).", + "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).", + "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).", + "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.", + "max_retries": "Maximum number of retries for failed requests.", + "min_delay_between_retries": "Minimum delay between retries.", + "statistics": "Statistics tracker for API calls. Created automatically if not provided.", + "headers": "Additional HTTP headers to include in all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 91 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the HTTP client base.\n" + } + ] + }, + "flags": {}, + "id": 1826, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Apify API token for authentication." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1827, + "kind": 32768, + "kindString": "Parameter", + "name": "token", + "type": { + "name": "str | None", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_SHORT", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1828, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_short", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_MEDIUM", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1829, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_medium", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_LONG", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1830, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_long", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum timeout cap for exponential timeout growth across retries." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_MAX", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1831, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_max", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of retries for failed requests." + } + ] + }, + "defaultValue": "DEFAULT_MAX_RETRIES", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1832, + "kind": 32768, + "kindString": "Parameter", + "name": "max_retries", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Minimum delay between retries." + } + ] + }, + "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1833, + "kind": 32768, + "kindString": "Parameter", + "name": "min_delay_between_retries", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statistics tracker for API calls. Created automatically if not provided." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1834, + "kind": 32768, + "kindString": "Parameter", + "name": "statistics", + "type": { + "name": "ClientStatistics | None", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Additional HTTP headers to include in all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1835, + "kind": 32768, + "kindString": "Parameter", + "name": "headers", + "type": { + "name": "dict[str, str] | None", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "reference" + }, + "inheritedFrom": { + "name": "HttpClientBase.__init__", + "target": 1825, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "HttpClientBase.__init__", + "target": 1825, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Abstract base class for asynchronous HTTP clients used by `ApifyClientAsync`.\n\nExtend this class to create a custom asynchronous HTTP client. See `HttpClient`\nfor details on the expected behavior." + } + ] + }, + "decorations": [ + { + "args": "('HTTP clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 4019, + 1848 + ], + "title": "Methods" + } + ], + "id": 1847, + "module": "http_clients._base", + "name": "HttpClientAsync", + "parsedDocstring": { + "text": "Abstract base class for asynchronous HTTP clients used by `ApifyClientAsync`.\n\nExtend this class to create a custom asynchronous HTTP client. See `HttpClient`\nfor details on the expected behavior." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_base.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 288 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "HttpClientBase", + "target": "1824", + "type": "reference" + } + ], + "extendedBy": [ + { + "name": "ImpitHttpClientAsync", + "target": "1882", + "type": "reference" + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1858, + "module": "http_clients._impit", + "name": "T", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_impit.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 34 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 1859, + "module": "http_clients._impit", + "name": "logger", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_impit.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 36 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the Impit-based synchronous HTTP client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1861, + "module": "http_clients._impit", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the Impit-based synchronous HTTP client.\n", + "args": { + "token": "Apify API token for authentication.", + "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).", + "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).", + "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).", + "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.", + "max_retries": "Maximum number of retry attempts for failed requests.", + "min_delay_between_retries": "Minimum delay between retries (increases exponentially with each attempt).", + "statistics": "Statistics tracker for API calls. Created automatically if not provided.", + "headers": "Additional HTTP headers to include in all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_impit.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 64 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the Impit-based synchronous HTTP client.\n" + } + ] + }, + "flags": {}, + "id": 1862, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Apify API token for authentication." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1863, + "kind": 32768, + "kindString": "Parameter", + "name": "token", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_SHORT", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1864, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_short", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_MEDIUM", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1865, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_medium", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_LONG", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1866, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_long", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum timeout cap for exponential timeout growth across retries." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_MAX", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1867, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_max", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of retry attempts for failed requests." + } + ] + }, + "defaultValue": "DEFAULT_MAX_RETRIES", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1868, + "kind": 32768, + "kindString": "Parameter", + "name": "max_retries", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Minimum delay between retries (increases exponentially with each attempt)." + } + ] + }, + "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1869, + "kind": 32768, + "kindString": "Parameter", + "name": "min_delay_between_retries", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statistics tracker for API calls. Created automatically if not provided." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1870, + "kind": 32768, + "kindString": "Parameter", + "name": "statistics", + "type": { + "name": "ClientStatistics | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ClientStatistics", + "target": "1" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Additional HTTP headers to include in all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1871, + "kind": 32768, + "kindString": "Parameter", + "name": "headers", + "type": { + "name": "dict[str, str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "str" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "HttpClient.__init__", + "target": 4018, + "type": "reference" + } + } + ], + "overwrites": { + "name": "HttpClient.__init__", + "target": 4018, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Make an HTTP request with automatic retry and exponential backoff.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1872, + "module": "http_clients._impit", + "name": "call", + "parsedDocstring": { + "text": "Make an HTTP request with automatic retry and exponential backoff.\n", + "args": { + "method": "HTTP method (GET, POST, PUT, DELETE, etc.).", + "url": "Full URL to make the request to.", + "headers": "Additional headers to include.", + "params": "Query parameters to append to the URL.", + "data": "Raw request body data. Cannot be used together with json.", + "json": "JSON-serializable data for the request body. Cannot be used together with data.", + "stream": "Whether to stream the response body.", + "timeout": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n" + }, + "returns": "The HTTP response object." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_impit.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 107 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The HTTP response object." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Make an HTTP request with automatic retry and exponential backoff.\n" + } + ] + }, + "flags": {}, + "id": 1873, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "call", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP method (GET, POST, PUT, DELETE, etc.)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1874, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Full URL to make the request to." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1875, + "kind": 32768, + "kindString": "Parameter", + "name": "url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Additional headers to include." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1876, + "kind": 32768, + "kindString": "Parameter", + "name": "headers", + "type": { + "name": "dict[str, str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "str" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Query parameters to append to the URL." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1877, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict[str, Any] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Raw request body data. Cannot be used together with json." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1878, + "kind": 32768, + "kindString": "Parameter", + "name": "data", + "type": { + "name": "str | bytes | bytearray | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "bytes" + } + ] + }, + { + "type": "reference", + "name": "bytearray" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "JSON-serializable data for the request body. Cannot be used together with data." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1879, + "kind": 32768, + "kindString": "Parameter", + "name": "json", + "type": { + "name": "JsonSerializable | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "JsonSerializable", + "target": "15" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to stream the response body." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1880, + "kind": 32768, + "kindString": "Parameter", + "name": "stream", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1881, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + }, + "overwrites": { + "name": "HttpClient.call", + "target": 1837, + "type": "reference" + } + } + ], + "overwrites": { + "name": "HttpClient.call", + "target": 1837, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Synchronous HTTP client for the Apify API built on top of [Impit](https://github.com/apify/impit).\n\nImpit is a high-performance HTTP client written in Rust that provides browser-like TLS fingerprints,\nautomatic header ordering, and HTTP/2 support. This client wraps `impit.Client` and adds automatic retries\nwith exponential backoff for rate-limited (HTTP 429) and server error (HTTP 5xx) responses." + } + ] + }, + "decorations": [ + { + "args": "('HTTP clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1861, + 1872 + ], + "title": "Methods" + } + ], + "id": 1860, + "module": "http_clients._impit", + "name": "ImpitHttpClient", + "parsedDocstring": { + "text": "Synchronous HTTP client for the Apify API built on top of [Impit](https://github.com/apify/impit).\n\nImpit is a high-performance HTTP client written in Rust that provides browser-like TLS fingerprints,\nautomatic header ordering, and HTTP/2 support. This client wraps `impit.Client` and adds automatic retries\nwith exponential backoff for rate-limited (HTTP 429) and server error (HTTP 5xx) responses." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_impit.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 56 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "HttpClient", + "target": "1836", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the Impit-based asynchronous HTTP client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1883, + "module": "http_clients._impit", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the Impit-based asynchronous HTTP client.\n", + "args": { + "token": "Apify API token for authentication.", + "timeout_short": "Default timeout for short-duration API operations (simple CRUD operations, ...).", + "timeout_medium": "Default timeout for medium-duration API operations (batch operations, listing, ...).", + "timeout_long": "Default timeout for long-duration API operations (long-polling, streaming, ...).", + "timeout_max": "Maximum timeout cap for exponential timeout growth across retries.", + "max_retries": "Maximum number of retry attempts for failed requests.", + "min_delay_between_retries": "Minimum delay between retries (increases exponentially with each attempt).", + "statistics": "Statistics tracker for API calls. Created automatically if not provided.", + "headers": "Additional HTTP headers to include in all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_impit.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 311 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the Impit-based asynchronous HTTP client.\n" + } + ] + }, + "flags": {}, + "id": 1884, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Apify API token for authentication." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1885, + "kind": 32768, + "kindString": "Parameter", + "name": "token", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for short-duration API operations (simple CRUD operations, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_SHORT", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1886, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_short", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for medium-duration API operations (batch operations, listing, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_MEDIUM", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1887, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_medium", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for long-duration API operations (long-polling, streaming, ...)." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_LONG", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1888, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_long", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum timeout cap for exponential timeout growth across retries." + } + ] + }, + "defaultValue": "DEFAULT_TIMEOUT_MAX", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1889, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_max", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of retry attempts for failed requests." + } + ] + }, + "defaultValue": "DEFAULT_MAX_RETRIES", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1890, + "kind": 32768, + "kindString": "Parameter", + "name": "max_retries", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Minimum delay between retries (increases exponentially with each attempt)." + } + ] + }, + "defaultValue": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1891, + "kind": 32768, + "kindString": "Parameter", + "name": "min_delay_between_retries", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statistics tracker for API calls. Created automatically if not provided." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1892, + "kind": 32768, + "kindString": "Parameter", + "name": "statistics", + "type": { + "name": "ClientStatistics | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ClientStatistics", + "target": "1" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Additional HTTP headers to include in all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1893, + "kind": 32768, + "kindString": "Parameter", + "name": "headers", + "type": { + "name": "dict[str, str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "str" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "HttpClientAsync.__init__", + "target": 4019, + "type": "reference" + } + } + ], + "overwrites": { + "name": "HttpClientAsync.__init__", + "target": 4019, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Make an HTTP request with automatic retry and exponential backoff.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1894, + "module": "http_clients._impit", + "name": "call", + "parsedDocstring": { + "text": "Make an HTTP request with automatic retry and exponential backoff.\n", + "args": { + "method": "HTTP method (GET, POST, PUT, DELETE, etc.).", + "url": "Full URL to make the request to.", + "headers": "Additional headers to include.", + "params": "Query parameters to append to the URL.", + "data": "Raw request body data. Cannot be used together with json.", + "json": "JSON-serializable data for the request body. Cannot be used together with data.", + "stream": "Whether to stream the response body.", + "timeout": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n" + }, + "returns": "The HTTP response object." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_impit.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 354 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The HTTP response object." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Make an HTTP request with automatic retry and exponential backoff.\n" + } + ] + }, + "flags": {}, + "id": 1895, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "call", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP method (GET, POST, PUT, DELETE, etc.)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1896, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Full URL to make the request to." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 1897, + "kind": 32768, + "kindString": "Parameter", + "name": "url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Additional headers to include." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1898, + "kind": 32768, + "kindString": "Parameter", + "name": "headers", + "type": { + "name": "dict[str, str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "str" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Query parameters to append to the URL." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1899, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict[str, Any] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Raw request body data. Cannot be used together with json." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1900, + "kind": 32768, + "kindString": "Parameter", + "name": "data", + "type": { + "name": "str | bytes | bytearray | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "bytes" + } + ] + }, + { + "type": "reference", + "name": "bytearray" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "JSON-serializable data for the request body. Cannot be used together with data." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1901, + "kind": 32768, + "kindString": "Parameter", + "name": "json", + "type": { + "name": "JsonSerializable | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "JsonSerializable", + "target": "15" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to stream the response body." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1902, + "kind": 32768, + "kindString": "Parameter", + "name": "stream", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request. Use `short`, `medium`, or `long` tier literals for\npreconfigured timeouts. A `timedelta` overrides it for this call, and `no_timeout` disables\nthe timeout entirely.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1903, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "HttpResponse", + "type": "reference", + "target": "1805" + }, + "overwrites": { + "name": "HttpClientAsync.call", + "target": 1848, + "type": "reference" + } + } + ], + "overwrites": { + "name": "HttpClientAsync.call", + "target": 1848, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Asynchronous HTTP client for the Apify API built on top of [Impit](https://github.com/apify/impit).\n\nImpit is a high-performance HTTP client written in Rust that provides browser-like TLS fingerprints,\nautomatic header ordering, and HTTP/2 support. This client wraps `impit.AsyncClient` and adds automatic retries\nwith exponential backoff for rate-limited (HTTP 429) and server error (HTTP 5xx) responses." + } + ] + }, + "decorations": [ + { + "args": "('HTTP clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1883, + 1894 + ], + "title": "Methods" + } + ], + "id": 1882, + "module": "http_clients._impit", + "name": "ImpitHttpClientAsync", + "parsedDocstring": { + "text": "Asynchronous HTTP client for the Apify API built on top of [Impit](https://github.com/apify/impit).\n\nImpit is a high-performance HTTP client written in Rust that provides browser-like TLS fingerprints,\nautomatic header ordering, and HTTP/2 support. This client wraps `impit.AsyncClient` and adds automatic retries\nwith exponential backoff for rate-limited (HTTP 429) and server error (HTTP 5xx) responses." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/http_clients/_impit.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 303 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "HttpClientAsync", + "target": "1847", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1905, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 28 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1910, + "module": "_resource_clients.schedule", + "name": "get", + "parsedDocstring": { + "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved schedule." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 41 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved schedule." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n" + } + ] + }, + "flags": {}, + "id": 1911, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1912, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Schedule | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Schedule", + "target": "1115" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1913, + "module": "_resource_clients.schedule", + "name": "update", + "parsedDocstring": { + "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n", + "args": { + "cron_expression": "The cron expression used by this schedule.", + "is_enabled": "True if the schedule should be enabled.", + "is_exclusive": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule.", + "name": "The name of the schedule to create.", + "actions": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure.", + "description": "Description of this schedule.", + "timezone": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones).", + "title": "A human-friendly equivalent of the name.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated schedule." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 57 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated schedule." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n" + } + ] + }, + "flags": {}, + "id": 1914, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cron expression used by this schedule." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1915, + "kind": 32768, + "kindString": "Parameter", + "name": "cron_expression", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "True if the schedule should be enabled." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1916, + "kind": 32768, + "kindString": "Parameter", + "name": "is_enabled", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1917, + "kind": 32768, + "kindString": "Parameter", + "name": "is_exclusive", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the schedule to create." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1918, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1919, + "kind": 32768, + "kindString": "Parameter", + "name": "actions", + "type": { + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Description of this schedule." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1920, + "kind": 32768, + "kindString": "Parameter", + "name": "description", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1921, + "kind": 32768, + "kindString": "Parameter", + "name": "timezone", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A human-friendly equivalent of the name." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1922, + "kind": 32768, + "kindString": "Parameter", + "name": "title", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1923, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Schedule", + "type": "reference", + "target": "1115" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1924, + "module": "_resource_clients.schedule", + "name": "delete", + "parsedDocstring": { + "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 103 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule\n" + } + ] + }, + "flags": {}, + "id": 1925, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1926, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1927, + "module": "_resource_clients.schedule", + "name": "get_log", + "parsedDocstring": { + "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "Retrieved log of the given schedule." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 113 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Retrieved log of the given schedule." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n" + } + ] + }, + "flags": {}, + "id": 1928, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_log", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1929, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ScheduleInvoked", + "target": "1141" + } + ], + "target": "2199" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3991, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific schedule.\n\nProvides methods to manage a specific schedule, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1905, + 1924, + 1910, + 1927, + 1913 + ], + "title": "Methods" + }, + { + "children": [ + 3991 + ], + "title": "Properties" + } + ], + "id": 1904, + "module": "_resource_clients.schedule", + "name": "ScheduleClient", + "parsedDocstring": { + "text": "Sub-client for managing a specific schedule.\n\nProvides methods to manage a specific schedule, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 21 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1931, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 145 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1936, + "module": "_resource_clients.schedule", + "name": "get", + "parsedDocstring": { + "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved schedule." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 158 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved schedule." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return information about the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/get-schedule\n" + } + ] + }, + "flags": {}, + "id": 1937, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1938, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Schedule | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Schedule", + "target": "1115" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1939, + "module": "_resource_clients.schedule", + "name": "update", + "parsedDocstring": { + "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n", + "args": { + "cron_expression": "The cron expression used by this schedule.", + "is_enabled": "True if the schedule should be enabled.", + "is_exclusive": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule.", + "name": "The name of the schedule to create.", + "actions": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure.", + "description": "Description of this schedule.", + "timezone": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones).", + "title": "A human-friendly equivalent of the name.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated schedule." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 174 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated schedule." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the schedule with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/update-schedule\n" + } + ] + }, + "flags": {}, + "id": 1940, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cron expression used by this schedule." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1941, + "kind": 32768, + "kindString": "Parameter", + "name": "cron_expression", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "True if the schedule should be enabled." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1942, + "kind": 32768, + "kindString": "Parameter", + "name": "is_enabled", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1943, + "kind": 32768, + "kindString": "Parameter", + "name": "is_exclusive", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the schedule to create." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1944, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1945, + "kind": 32768, + "kindString": "Parameter", + "name": "actions", + "type": { + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Description of this schedule." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1946, + "kind": 32768, + "kindString": "Parameter", + "name": "description", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1947, + "kind": 32768, + "kindString": "Parameter", + "name": "timezone", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A human-friendly equivalent of the name." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1948, + "kind": 32768, + "kindString": "Parameter", + "name": "title", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1949, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Schedule", + "type": "reference", + "target": "1115" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1950, + "module": "_resource_clients.schedule", + "name": "delete", + "parsedDocstring": { + "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 220 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule\n" + } + ] + }, + "flags": {}, + "id": 1951, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1952, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1953, + "module": "_resource_clients.schedule", + "name": "get_log", + "parsedDocstring": { + "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "Retrieved log of the given schedule." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 230 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Retrieved log of the given schedule." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return log for the given schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-log/get-schedule-log\n" + } + ] + }, + "flags": {}, + "id": 1954, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_log", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1955, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ScheduleInvoked", + "target": "1141" + } + ], + "target": "2199" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3964, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific schedule.\n\nProvides methods to manage a specific schedule, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1931, + 1950, + 1936, + 1953, + 1939 + ], + "title": "Methods" + }, + { + "children": [ + 3964 + ], + "title": "Properties" + } + ], + "id": 1930, + "module": "_resource_clients.schedule", + "name": "ScheduleClientAsync", + "parsedDocstring": { + "text": "Sub-client for managing a specific schedule.\n\nProvides methods to manage a specific schedule, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 138 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1957, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/user.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 33 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1962, + "module": "_resource_clients.user", + "name": "get", + "parsedDocstring": { + "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved user data, or None if the user does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/user.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 46 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved user data, or None if the user does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n" + } + ] + }, + "flags": {}, + "id": 1963, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1964, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "UserPublicInfo | UserPrivateInfo | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "UserPublicInfo", + "target": "1325" + }, + { + "type": "reference", + "name": "UserPrivateInfo", + "target": "1314" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1965, + "module": "_resource_clients.user", + "name": "monthly_usage", + "parsedDocstring": { + "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved monthly usage." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/user.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 67 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved monthly usage." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n" + } + ] + }, + "flags": {}, + "id": 1966, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "monthly_usage", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1967, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "MonthlyUsage", + "type": "reference", + "target": "736" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/users/account-limits/get-account-limits\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1968, + "module": "_resource_clients.user", + "name": "limits", + "parsedDocstring": { + "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/users/account-limits/get-account-limits\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The account limits." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/user.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 94 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The account limits." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/users/account-limits/get-account-limits\n" + } + ] + }, + "flags": {}, + "id": 1969, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "limits", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1970, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AccountLimits", + "type": "reference", + "target": "187" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the account's limits manageable on your account's Limits page.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1971, + "module": "_resource_clients.user", + "name": "update_limits", + "parsedDocstring": { + "text": "Update the account's limits manageable on your account's Limits page.\n", + "args": { + "max_monthly_usage_usd": "Maximum monthly usage in USD.", + "data_retention_days": "Data retention period in days.", + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/user.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 120 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the account's limits manageable on your account's Limits page.\n" + } + ] + }, + "flags": {}, + "id": 1972, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "update_limits", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum monthly usage in USD." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1973, + "kind": 32768, + "kindString": "Parameter", + "name": "max_monthly_usage_usd", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Data retention period in days." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1974, + "kind": 32768, + "kindString": "Parameter", + "name": "data_retention_days", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1975, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3992, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing user account information.\n\nProvides methods to manage user account information, e.g. get user data or monthly usage. Obtain an instance via\nan appropriate method on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1957, + 1962, + 1968, + 1965, + 1971 + ], + "title": "Methods" + }, + { + "children": [ + 3992 + ], + "title": "Properties" + } + ], + "id": 1956, + "module": "_resource_clients.user", + "name": "UserClient", + "parsedDocstring": { + "text": "Sub-client for managing user account information.\n\nProvides methods to manage user account information, e.g. get user data or monthly usage. Obtain an instance via\nan appropriate method on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/user.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 26 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1977, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/user.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 156 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1982, + "module": "_resource_clients.user", + "name": "get", + "parsedDocstring": { + "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved user data, or None if the user does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/user.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 169 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved user data, or None if the user does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return information about user account.\n\nYou receive all or only public info based on your token permissions.\n\nhttps://docs.apify.com/api/v2#/reference/users\n" + } + ] + }, + "flags": {}, + "id": 1983, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1984, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "UserPublicInfo | UserPrivateInfo | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "UserPublicInfo", + "target": "1325" + }, + { + "type": "reference", + "name": "UserPrivateInfo", + "target": "1314" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1985, + "module": "_resource_clients.user", + "name": "monthly_usage", + "parsedDocstring": { + "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved monthly usage." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/user.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 190 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved monthly usage." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return monthly usage of the user account.\n\nThis includes a complete usage summary for the current usage cycle, an overall sum, as well as a daily breakdown\nof usage. It is the same information which is available on the account's Billing page. The information includes\nuse of storage, data transfer, and request queue usage.\n\nhttps://docs.apify.com/api/v2/#/reference/users/monthly-usage\n" + } + ] + }, + "flags": {}, + "id": 1986, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "monthly_usage", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1987, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "MonthlyUsage", + "type": "reference", + "target": "736" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/users/account-limits/get-account-limits\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1988, + "module": "_resource_clients.user", + "name": "limits", + "parsedDocstring": { + "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/users/account-limits/get-account-limits\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The account limits." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/user.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 217 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The account limits." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return a complete summary of the user account's limits.\n\nIt is the same information which is available on the account's Limits page. The returned data includes\nthe current usage cycle, a summary of the account's limits, and the current usage.\n\nhttps://docs.apify.com/api/v2#/reference/users/account-limits/get-account-limits\n" + } + ] + }, + "flags": {}, + "id": 1989, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "limits", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1990, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AccountLimits", + "type": "reference", + "target": "187" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the account's limits manageable on your account's Limits page.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1991, + "module": "_resource_clients.user", + "name": "update_limits", + "parsedDocstring": { + "text": "Update the account's limits manageable on your account's Limits page.\n", + "args": { + "max_monthly_usage_usd": "Maximum monthly usage in USD.", + "data_retention_days": "Data retention period in days.", + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/user.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 243 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the account's limits manageable on your account's Limits page.\n" + } + ] + }, + "flags": {}, + "id": 1992, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "update_limits", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum monthly usage in USD." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1993, + "kind": 32768, + "kindString": "Parameter", + "name": "max_monthly_usage_usd", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Data retention period in days." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1994, + "kind": 32768, + "kindString": "Parameter", + "name": "data_retention_days", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1995, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3965, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing user account information.\n\nProvides methods to manage user account information, e.g. get user data or monthly usage. Obtain an instance via\nan appropriate method on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1977, + 1982, + 1988, + 1985, + 1991 + ], + "title": "Methods" + }, + { + "children": [ + 3965 + ], + "title": "Properties" + } + ], + "id": 1976, + "module": "_resource_clients.user", + "name": "UserClientAsync", + "parsedDocstring": { + "text": "Sub-client for managing user account information.\n\nProvides methods to manage user account information, e.g. get user data or monthly usage. Obtain an instance via\nan appropriate method on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/user.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 149 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 1997, + "module": "_resource_clients.request_queue", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize a new instance.\n", + "args": { + "client_key": "A unique identifier of the client accessing the request queue." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 70 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n" + } + ] + }, + "flags": {}, + "id": 1998, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 1999, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "defaultValue": "'request-queues'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2000, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier of the client accessing the request queue." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2001, + "kind": 32768, + "kindString": "Parameter", + "name": "client_key", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2002, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2003, + "module": "_resource_clients.request_queue", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved request queue, or None, if it does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 90 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved request queue, or None, if it does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n" + } + ] + }, + "flags": {}, + "id": 2004, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2005, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "RequestQueue | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestQueue", + "target": "898" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2006, + "module": "_resource_clients.request_queue", + "name": "update", + "parsedDocstring": { + "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n", + "args": { + "name": "The new name for the request queue.", + "general_access": "Determines how others can access the request queue.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 106 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated request queue." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n" + } + ] + }, + "flags": {}, + "id": 2007, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new name for the request queue." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2008, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Determines how others can access the request queue." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2009, + "kind": 32768, + "kindString": "Parameter", + "name": "general_access", + "type": { + "name": "GeneralAccess | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "GeneralAccess", + "target": "1797" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2010, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "RequestQueue", + "type": "reference", + "target": "898" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2011, + "module": "_resource_clients.request_queue", + "name": "delete", + "parsedDocstring": { + "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 128 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue\n" + } + ] + }, + "flags": {}, + "id": 2012, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2013, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2014, + "module": "_resource_clients.request_queue", + "name": "list_head", + "parsedDocstring": { + "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n", + "args": { + "limit": "How many requests to retrieve.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The desired number of requests from the beginning of the queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 138 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The desired number of requests from the beginning of the queue." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n" + } + ] + }, + "flags": {}, + "id": 2015, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list_head", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many requests to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2016, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2017, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "RequestQueueHead", + "type": "reference", + "target": "913" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2018, + "module": "_resource_clients.request_queue", + "name": "list_and_lock_head", + "parsedDocstring": { + "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n", + "args": { + "lock_duration": "How long the requests will be locked for.", + "limit": "How many requests to retrieve.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The desired number of locked requests from the beginning of the queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 162 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The desired number of locked requests from the beginning of the queue." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n" + } + ] + }, + "flags": {}, + "id": 2019, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list_and_lock_head", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How long the requests will be locked for." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 2020, + "kind": 32768, + "kindString": "Parameter", + "name": "lock_duration", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many requests to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2021, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2022, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "LockedRequestQueueHead", + "type": "reference", + "target": "721" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2023, + "module": "_resource_clients.request_queue", + "name": "add_request", + "parsedDocstring": { + "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n", + "args": { + "request": "The request to add to the queue.", + "forefront": "Whether to add the request to the head or the end of the queue.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The added request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 197 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The added request." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n" + } + ] + }, + "flags": {}, + "id": 2024, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "add_request", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The request to add to the queue." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2025, + "kind": 32768, + "kindString": "Parameter", + "name": "request", + "type": { + "name": "RequestDraftDict | RequestDraftCamelDict | RequestDraft", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestDraftDict", + "target": "106" + }, + { + "type": "reference", + "name": "RequestDraftCamelDict", + "target": "111" + } + ] + }, + { + "type": "reference", + "name": "RequestDraft", + "target": "879" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to add the request to the head or the end of the queue." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2026, + "kind": 32768, + "kindString": "Parameter", + "name": "forefront", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2027, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "RequestRegistration", + "type": "reference", + "target": "948" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2028, + "module": "_resource_clients.request_queue", + "name": "get_request", + "parsedDocstring": { + "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n", + "args": { + "request_id": "ID of the request to retrieve.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved request, or None, if it did not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 232 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved request, or None, if it did not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n" + } + ] + }, + "flags": {}, + "id": 2029, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_request", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the request to retrieve." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2030, + "kind": 32768, + "kindString": "Parameter", + "name": "request_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2031, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Request | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Request", + "target": "876" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2032, + "module": "_resource_clients.request_queue", + "name": "update_request", + "parsedDocstring": { + "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n", + "args": { + "request": "The updated request.", + "forefront": "Whether to put the updated request in the beginning or the end of the queue.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 259 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated request." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n" + } + ] + }, + "flags": {}, + "id": 2033, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "update_request", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The updated request." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2034, + "kind": 32768, + "kindString": "Parameter", + "name": "request", + "type": { + "name": "RequestDict | RequestCamelDict | Request", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestDict", + "target": "102" + }, + { + "type": "reference", + "name": "RequestCamelDict", + "target": "104" + } + ] + }, + { + "type": "reference", + "name": "Request", + "target": "876" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to put the updated request in the beginning or the end of the queue." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2035, + "kind": 32768, + "kindString": "Parameter", + "name": "forefront", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2036, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "RequestRegistration", + "type": "reference", + "target": "948" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2037, + "module": "_resource_clients.request_queue", + "name": "delete_request", + "parsedDocstring": { + "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n", + "args": { + "request_id": "ID of the request to delete.", + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 294 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n" + } + ] + }, + "flags": {}, + "id": 2038, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete_request", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the request to delete." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2039, + "kind": 32768, + "kindString": "Parameter", + "name": "request_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2040, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2041, + "module": "_resource_clients.request_queue", + "name": "prolong_request_lock", + "parsedDocstring": { + "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n", + "args": { + "request_id": "ID of the request to prolong the lock.", + "forefront": "Whether to put the request in the beginning or the end of the queue after lock expires.", + "lock_duration": "By how much to prolong the lock.", + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 314 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n" + } + ] + }, + "flags": {}, + "id": 2042, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "prolong_request_lock", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the request to prolong the lock." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2043, + "kind": 32768, + "kindString": "Parameter", + "name": "request_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to put the request in the beginning or the end of the queue after lock expires." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2044, + "kind": 32768, + "kindString": "Parameter", + "name": "forefront", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "By how much to prolong the lock." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 2045, + "kind": 32768, + "kindString": "Parameter", + "name": "lock_duration", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2046, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "RequestLockInfo | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestLockInfo", + "target": "895" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2047, + "module": "_resource_clients.request_queue", + "name": "delete_request_lock", + "parsedDocstring": { + "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n", + "args": { + "request_id": "ID of the request to delete the lock.", + "forefront": "Whether to put the request in the beginning or the end of the queue after the lock is deleted.", + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 348 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n" + } + ] + }, + "flags": {}, + "id": 2048, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete_request_lock", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the request to delete the lock." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2049, + "kind": 32768, + "kindString": "Parameter", + "name": "request_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to put the request in the beginning or the end of the queue after the lock is deleted." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2050, + "kind": 32768, + "kindString": "Parameter", + "name": "forefront", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2051, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2052, + "module": "_resource_clients.request_queue", + "name": "batch_add_requests", + "parsedDocstring": { + "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n", + "args": { + "requests": "List of requests to be added to the queue.", + "forefront": "Whether to add requests to the front of the queue.", + "max_parallel": "Specifies the maximum number of parallel tasks for API calls. This is only applicable\nto the async client. For the sync client, this value must be set to 1, as parallel execution\nis not supported.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "Result containing lists of processed and unprocessed requests." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 373 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Result containing lists of processed and unprocessed requests." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n" + } + ] + }, + "flags": {}, + "id": 2053, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "batch_add_requests", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of requests to be added to the queue." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2054, + "kind": 32768, + "kindString": "Parameter", + "name": "requests", + "type": { + "name": "list[RequestDraft] | list[RequestDraftDict] | list[RequestDraftCamelDict]", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "RequestDraft", + "target": "879" + } + ], + "target": "2199" + }, + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "RequestDraftDict", + "target": "106" + } + ], + "target": "2199" + } + ] + }, + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "RequestDraftCamelDict", + "target": "111" + } + ], + "target": "2199" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to add requests to the front of the queue." + } + ] + }, + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2055, + "kind": 32768, + "kindString": "Parameter", + "name": "forefront", + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the maximum number of parallel tasks for API calls. This is only applicable\nto the async client. For the sync client, this value must be set to 1, as parallel execution\nis not supported." + } + ] + }, + "defaultValue": "1", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2056, + "kind": 32768, + "kindString": "Parameter", + "name": "max_parallel", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2057, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "BatchAddResult", + "type": "reference", + "target": "287" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2058, + "module": "_resource_clients.request_queue", + "name": "batch_delete_requests", + "parsedDocstring": { + "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n", + "args": { + "requests": "List of the requests to delete.", + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 454 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n" + } + ] + }, + "flags": {}, + "id": 2059, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "batch_delete_requests", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of the requests to delete." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2060, + "kind": 32768, + "kindString": "Parameter", + "name": "requests", + "type": { + "name": "list[RequestDraftDelete] | list[RequestDraftDeleteDict] | list[RequestDraftDeleteCamelDict]", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "RequestDraftDelete", + "target": "893" + } + ], + "target": "2199" + }, + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "RequestDraftDeleteByIdDict | RequestDraftDeleteByUniqueKeyDict" + } + ], + "target": "2199" + } + ] + }, + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "RequestDraftDeleteByIdCamelDict | RequestDraftDeleteByUniqueKeyCamelDict" + } + ], + "target": "2199" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2061, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "BatchDeleteResult", + "type": "reference", + "target": "294" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2062, + "module": "_resource_clients.request_queue", + "name": "list_requests", + "parsedDocstring": { + "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n", + "args": { + "limit": "How many requests to retrieve.", + "filter": "List of request states to use as a filter. Multiple values mean union of the given filters.", + "timeout": "Timeout for the API HTTP request.", + "cursor": "A token returned in previous API response, to continue listing next page of requests" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 492 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n" + } + ] + }, + "flags": {}, + "id": 2063, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list_requests", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many requests to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2064, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of request states to use as a filter. Multiple values mean union of the given filters." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2065, + "kind": 32768, + "kindString": "Parameter", + "name": "filter", + "type": { + "name": "list[Literal['pending', 'locked']] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "pending" + }, + { + "type": "literal", + "value": "locked" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2066, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A token returned in previous API response, to continue listing next page of requests" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2067, + "kind": 32768, + "kindString": "Parameter", + "name": "cursor", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "ListOfRequests", + "type": "reference", + "target": "681" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over requests in the queue.\n\nSimple `list_requests` does only one API call, possibly not listing all items matching the criteria.\nThis method returns an iterator that is capable of making multiple API calls to retrieve all items\nmatching the criteria using the opaque `cursor` returned by the API.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2068, + "module": "_resource_clients.request_queue", + "name": "iterate_requests", + "parsedDocstring": { + "text": "Iterate over requests in the queue.\n\nSimple `list_requests` does only one API call, possibly not listing all items matching the criteria.\nThis method returns an iterator that is capable of making multiple API calls to retrieve all items\nmatching the criteria using the opaque `cursor` returned by the API.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n", + "args": { + "limit": "Maximum number of requests to yield across all pages.", + "filter": "List of request states to use as a filter. Multiple values mean union of the given filters.", + "cursor": "A token returned in a previous API response, used as the initial pagination cursor.", + "chunk_size": "Maximum number of requests requested per API call when iterating across pages.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 527 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over requests in the queue.\n\nSimple `list_requests` does only one API call, possibly not listing all items matching the criteria.\nThis method returns an iterator that is capable of making multiple API calls to retrieve all items\nmatching the criteria using the opaque `cursor` returned by the API.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n" + } + ] + }, + "flags": {}, + "id": 2069, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate_requests", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of requests to yield across all pages." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2070, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of request states to use as a filter. Multiple values mean union of the given filters." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2071, + "kind": 32768, + "kindString": "Parameter", + "name": "filter", + "type": { + "name": "list[Literal['pending', 'locked']] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "pending" + }, + { + "type": "literal", + "value": "locked" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A token returned in a previous API response, used as the initial pagination cursor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2072, + "kind": 32768, + "kindString": "Parameter", + "name": "cursor", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of requests requested per API call when iterating across pages." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2073, + "kind": 32768, + "kindString": "Parameter", + "name": "chunk_size", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2074, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Request", + "target": "876" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2075, + "module": "_resource_clients.request_queue", + "name": "unlock_requests", + "parsedDocstring": { + "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "Result of the unlock operation containing the count of unlocked requests" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 565 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Result of the unlock operation containing the count of unlocked requests" + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n" + } + ] + }, + "flags": {}, + "id": 2076, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "unlock_requests", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2077, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "UnlockRequestsResult", + "type": "reference", + "target": "1253" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3993, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific request queue.\n\nProvides methods to manage a specific request queue, e.g. update it, delete it, or manage its requests. Obtain an\ninstance via an appropriate method on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1997, + 2023, + 2052, + 2058, + 2011, + 2037, + 2047, + 2003, + 2028, + 2068, + 2018, + 2014, + 2062, + 2041, + 2075, + 2006, + 2032 + ], + "title": "Methods" + }, + { + "children": [ + 3993 + ], + "title": "Properties" + } + ], + "id": 1996, + "module": "_resource_clients.request_queue", + "name": "RequestQueueClient", + "parsedDocstring": { + "text": "Sub-client for managing a specific request queue.\n\nProvides methods to manage a specific request queue, e.g. update it, delete it, or manage its requests. Obtain an\ninstance via an appropriate method on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 63 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2079, + "module": "_resource_clients.request_queue", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize a new instance.\n", + "args": { + "client_key": "A unique identifier of the client accessing the request queue." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 597 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a new instance.\n" + } + ] + }, + "flags": {}, + "id": 2080, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2081, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "defaultValue": "'request-queues'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2082, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier of the client accessing the request queue." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2083, + "kind": 32768, + "kindString": "Parameter", + "name": "client_key", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2084, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2085, + "module": "_resource_clients.request_queue", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved request queue, or None, if it does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 617 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved request queue, or None, if it does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/get-request-queue\n" + } + ] + }, + "flags": {}, + "id": 2086, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2087, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "RequestQueue | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestQueue", + "target": "898" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2088, + "module": "_resource_clients.request_queue", + "name": "update", + "parsedDocstring": { + "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n", + "args": { + "name": "The new name for the request queue.", + "general_access": "Determines how others can access the request queue.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 633 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated request queue." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the request queue with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue\n" + } + ] + }, + "flags": {}, + "id": 2089, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new name for the request queue." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2090, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Determines how others can access the request queue." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2091, + "kind": 32768, + "kindString": "Parameter", + "name": "general_access", + "type": { + "name": "GeneralAccess | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "GeneralAccess", + "target": "1797" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2092, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "RequestQueue", + "type": "reference", + "target": "898" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2093, + "module": "_resource_clients.request_queue", + "name": "delete", + "parsedDocstring": { + "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 655 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the request queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue\n" + } + ] + }, + "flags": {}, + "id": 2094, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2095, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2096, + "module": "_resource_clients.request_queue", + "name": "list_head", + "parsedDocstring": { + "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n", + "args": { + "limit": "How many requests to retrieve.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The desired number of requests from the beginning of the queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 665 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The desired number of requests from the beginning of the queue." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of requests from the beginning of the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head/get-head\n" + } + ] + }, + "flags": {}, + "id": 2097, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "list_head", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many requests to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2098, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2099, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "RequestQueueHead", + "type": "reference", + "target": "913" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2100, + "module": "_resource_clients.request_queue", + "name": "list_and_lock_head", + "parsedDocstring": { + "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n", + "args": { + "lock_duration": "How long the requests will be locked for.", + "limit": "How many requests to retrieve.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The desired number of locked requests from the beginning of the queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 689 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The desired number of locked requests from the beginning of the queue." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-head-with-locks/get-head-and-lock\n" + } + ] + }, + "flags": {}, + "id": 2101, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "list_and_lock_head", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How long the requests will be locked for." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 2102, + "kind": 32768, + "kindString": "Parameter", + "name": "lock_duration", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many requests to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2103, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2104, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "LockedRequestQueueHead", + "type": "reference", + "target": "721" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2105, + "module": "_resource_clients.request_queue", + "name": "add_request", + "parsedDocstring": { + "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n", + "args": { + "request": "The request to add to the queue.", + "forefront": "Whether to add the request to the head or the end of the queue.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The added request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 724 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The added request." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Add a request to the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request\n" + } + ] + }, + "flags": {}, + "id": 2106, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "add_request", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The request to add to the queue." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2107, + "kind": 32768, + "kindString": "Parameter", + "name": "request", + "type": { + "name": "RequestDraftDict | RequestDraftCamelDict | RequestDraft", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestDraftDict", + "target": "106" + }, + { + "type": "reference", + "name": "RequestDraftCamelDict", + "target": "111" + } + ] + }, + { + "type": "reference", + "name": "RequestDraft", + "target": "879" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to add the request to the head or the end of the queue." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2108, + "kind": 32768, + "kindString": "Parameter", + "name": "forefront", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2109, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "RequestRegistration", + "type": "reference", + "target": "948" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2110, + "module": "_resource_clients.request_queue", + "name": "get_request", + "parsedDocstring": { + "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n", + "args": { + "request_id": "ID of the request to retrieve.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved request, or None, if it did not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 759 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved request, or None, if it did not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/get-request\n" + } + ] + }, + "flags": {}, + "id": 2111, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_request", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the request to retrieve." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2112, + "kind": 32768, + "kindString": "Parameter", + "name": "request_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2113, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Request | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Request", + "target": "876" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2114, + "module": "_resource_clients.request_queue", + "name": "update_request", + "parsedDocstring": { + "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n", + "args": { + "request": "The updated request.", + "forefront": "Whether to put the updated request in the beginning or the end of the queue.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 784 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated request." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update a request in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/update-request\n" + } + ] + }, + "flags": {}, + "id": 2115, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "update_request", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The updated request." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2116, + "kind": 32768, + "kindString": "Parameter", + "name": "request", + "type": { + "name": "RequestDict | RequestCamelDict | Request", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestDict", + "target": "102" + }, + { + "type": "reference", + "name": "RequestCamelDict", + "target": "104" + } + ] + }, + { + "type": "reference", + "name": "Request", + "target": "876" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to put the updated request in the beginning or the end of the queue." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2117, + "kind": 32768, + "kindString": "Parameter", + "name": "forefront", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2118, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "RequestRegistration", + "type": "reference", + "target": "948" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2119, + "module": "_resource_clients.request_queue", + "name": "delete_request", + "parsedDocstring": { + "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n", + "args": { + "request_id": "ID of the request to delete.", + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 819 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete a request from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request/delete-request\n" + } + ] + }, + "flags": {}, + "id": 2120, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "delete_request", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the request to delete." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2121, + "kind": 32768, + "kindString": "Parameter", + "name": "request_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2122, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2123, + "module": "_resource_clients.request_queue", + "name": "prolong_request_lock", + "parsedDocstring": { + "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n", + "args": { + "request_id": "ID of the request to prolong the lock.", + "forefront": "Whether to put the request in the beginning or the end of the queue after lock expires.", + "lock_duration": "By how much to prolong the lock.", + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 837 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Prolong the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock\n" + } + ] + }, + "flags": {}, + "id": 2124, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "prolong_request_lock", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the request to prolong the lock." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2125, + "kind": 32768, + "kindString": "Parameter", + "name": "request_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to put the request in the beginning or the end of the queue after lock expires." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2126, + "kind": 32768, + "kindString": "Parameter", + "name": "forefront", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "By how much to prolong the lock." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 2127, + "kind": 32768, + "kindString": "Parameter", + "name": "lock_duration", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2128, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "RequestLockInfo | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "RequestLockInfo", + "target": "895" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2129, + "module": "_resource_clients.request_queue", + "name": "delete_request_lock", + "parsedDocstring": { + "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n", + "args": { + "request_id": "ID of the request to delete the lock.", + "forefront": "Whether to put the request in the beginning or the end of the queue after the lock is deleted.", + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 871 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the lock on a request.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock\n" + } + ] + }, + "flags": {}, + "id": 2130, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "delete_request_lock", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the request to delete the lock." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2131, + "kind": 32768, + "kindString": "Parameter", + "name": "request_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to put the request in the beginning or the end of the queue after the lock is deleted." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2132, + "kind": 32768, + "kindString": "Parameter", + "name": "forefront", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2133, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2134, + "module": "_resource_clients.request_queue", + "name": "batch_add_requests", + "parsedDocstring": { + "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n", + "args": { + "requests": "List of requests to be added to the queue.", + "forefront": "Whether to add requests to the front of the queue.", + "max_parallel": "Specifies the maximum number of parallel tasks for API calls. This is only applicable\nto the async client. For the sync client, this value must be set to 1, as parallel execution\nis not supported.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "Result containing lists of processed and unprocessed requests." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 945 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Result containing lists of processed and unprocessed requests." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Add requests to the request queue in batches.\n\nRequests are split into batches based on size and processed in parallel.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests\n" + } + ] + }, + "flags": {}, + "id": 2135, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "batch_add_requests", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of requests to be added to the queue." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2136, + "kind": 32768, + "kindString": "Parameter", + "name": "requests", + "type": { + "name": "list[RequestDraft] | list[RequestDraftDict] | list[RequestDraftCamelDict]", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "RequestDraft", + "target": "879" + } + ], + "target": "2199" + }, + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "RequestDraftDict", + "target": "106" + } + ], + "target": "2199" + } + ] + }, + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "RequestDraftCamelDict", + "target": "111" + } + ], + "target": "2199" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to add requests to the front of the queue." + } + ] + }, + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2137, + "kind": 32768, + "kindString": "Parameter", + "name": "forefront", + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the maximum number of parallel tasks for API calls. This is only applicable\nto the async client. For the sync client, this value must be set to 1, as parallel execution\nis not supported." + } + ] + }, + "defaultValue": "5", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2138, + "kind": 32768, + "kindString": "Parameter", + "name": "max_parallel", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2139, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "BatchAddResult", + "type": "reference", + "target": "287" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2140, + "module": "_resource_clients.request_queue", + "name": "batch_delete_requests", + "parsedDocstring": { + "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n", + "args": { + "requests": "List of the requests to delete.", + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1037 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete given requests from the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/delete-requests\n" + } + ] + }, + "flags": {}, + "id": 2141, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "batch_delete_requests", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of the requests to delete." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2142, + "kind": 32768, + "kindString": "Parameter", + "name": "requests", + "type": { + "name": "list[RequestDraftDelete] | list[RequestDraftDeleteDict] | list[RequestDraftDeleteCamelDict]", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "RequestDraftDelete", + "target": "893" + } + ], + "target": "2199" + }, + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "RequestDraftDeleteByIdDict | RequestDraftDeleteByUniqueKeyDict" + } + ], + "target": "2199" + } + ] + }, + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "RequestDraftDeleteByIdCamelDict | RequestDraftDeleteByUniqueKeyCamelDict" + } + ], + "target": "2199" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2143, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "BatchDeleteResult", + "type": "reference", + "target": "294" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2144, + "module": "_resource_clients.request_queue", + "name": "list_requests", + "parsedDocstring": { + "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n", + "args": { + "limit": "How many requests to retrieve.", + "filter": "List of request states to use as a filter. Multiple values mean union of the given filters.", + "timeout": "Timeout for the API HTTP request.", + "cursor": "A token returned in previous API response, to continue listing next page of requests" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1074 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "List requests in the queue.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n" + } + ] + }, + "flags": {}, + "id": 2145, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "list_requests", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many requests to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2146, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of request states to use as a filter. Multiple values mean union of the given filters." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2147, + "kind": 32768, + "kindString": "Parameter", + "name": "filter", + "type": { + "name": "list[Literal['pending', 'locked']] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "pending" + }, + { + "type": "literal", + "value": "locked" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2148, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A token returned in previous API response, to continue listing next page of requests" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2149, + "kind": 32768, + "kindString": "Parameter", + "name": "cursor", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "ListOfRequests", + "type": "reference", + "target": "681" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over requests in the queue.\n\nSimple `list_requests` does only one API call, possibly not listing all items matching the criteria.\nThis method returns an iterator that is capable of making multiple API calls to retrieve all items\nmatching the criteria using the opaque `cursor` returned by the API.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2150, + "module": "_resource_clients.request_queue", + "name": "iterate_requests", + "parsedDocstring": { + "text": "Iterate over requests in the queue.\n\nSimple `list_requests` does only one API call, possibly not listing all items matching the criteria.\nThis method returns an iterator that is capable of making multiple API calls to retrieve all items\nmatching the criteria using the opaque `cursor` returned by the API.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n", + "args": { + "limit": "Maximum number of requests to yield across all pages.", + "filter": "List of request states to use as a filter. Multiple values mean union of the given filters.", + "cursor": "A token returned in a previous API response, used as the initial pagination cursor.", + "chunk_size": "Maximum number of requests requested per API call when iterating across pages.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1109 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over requests in the queue.\n\nSimple `list_requests` does only one API call, possibly not listing all items matching the criteria.\nThis method returns an iterator that is capable of making multiple API calls to retrieve all items\nmatching the criteria using the opaque `cursor` returned by the API.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/list-requests\n" + } + ] + }, + "flags": {}, + "id": 2151, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate_requests", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of requests to yield across all pages." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2152, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of request states to use as a filter. Multiple values mean union of the given filters." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2153, + "kind": 32768, + "kindString": "Parameter", + "name": "filter", + "type": { + "name": "list[Literal['pending', 'locked']] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "pending" + }, + { + "type": "literal", + "value": "locked" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A token returned in a previous API response, used as the initial pagination cursor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2154, + "kind": 32768, + "kindString": "Parameter", + "name": "cursor", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of requests requested per API call when iterating across pages." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2155, + "kind": 32768, + "kindString": "Parameter", + "name": "chunk_size", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2156, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Request", + "target": "876" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2157, + "module": "_resource_clients.request_queue", + "name": "unlock_requests", + "parsedDocstring": { + "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "Result of the unlock operation containing the count of unlocked requests" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1147 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Result of the unlock operation containing the count of unlocked requests" + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Unlock all requests in the queue, which were locked by the same clientKey or from the same Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/request-collection/unlock-requests\n" + } + ] + }, + "flags": {}, + "id": 2158, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "unlock_requests", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2159, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "UnlockRequestsResult", + "type": "reference", + "target": "1253" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3966, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific request queue.\n\nProvides methods to manage a specific request queue, e.g. update it, delete it, or manage its requests. Obtain an\ninstance via an appropriate method on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2079, + 2105, + 2134, + 2140, + 2093, + 2119, + 2129, + 2085, + 2110, + 2150, + 2100, + 2096, + 2144, + 2123, + 2157, + 2088, + 2114 + ], + "title": "Methods" + }, + { + "children": [ + 3966 + ], + "title": "Properties" + } + ], + "id": 2078, + "module": "_resource_clients.request_queue", + "name": "RequestQueueClientAsync", + "parsedDocstring": { + "text": "Sub-client for managing a specific request queue.\n\nProvides methods to manage a specific request queue, e.g. update it, delete it, or manage its requests. Obtain an\ninstance via an appropriate method on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 590 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2161, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 26 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n404s collapse to `None` only when this client targets a specific log by ID (e.g. `client.log(run_id).get()`).\nFor chained clients without a `resource_id` (e.g. `run.log().get()`), a 404 is ambiguous and propagates.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2165, + "module": "_resource_clients.log", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n404s collapse to `None` only when this client targets a specific log by ID (e.g. `client.log(run_id).get()`).\nFor chained clients without a `resource_id` (e.g. `run.log().get()`), a 404 is ambiguous and propagates.\n", + "args": { + "raw": "If true, the log will include formatting. For example, coloring character sequences.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved log, or None, if it does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 37 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved log, or None, if it does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n404s collapse to `None` only when this client targets a specific log by ID (e.g. `client.log(run_id).get()`).\nFor chained clients without a `resource_id` (e.g. `run.log().get()`), a 404 is ambiguous and propagates.\n" + } + ] + }, + "flags": {}, + "id": 2166, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the log will include formatting. For example, coloring character sequences." + } + ] + }, + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2167, + "kind": 32768, + "kindString": "Parameter", + "name": "raw", + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2168, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2169, + "module": "_resource_clients.log", + "name": "get_as_bytes", + "parsedDocstring": { + "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n", + "args": { + "raw": "If true, the log will include formatting. For example, coloring character sequences.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved log as raw bytes, or None, if it does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 67 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved log as raw bytes, or None, if it does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n" + } + ] + }, + "flags": {}, + "id": 2170, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_as_bytes", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the log will include formatting. For example, coloring character sequences." + } + ] + }, + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2171, + "kind": 32768, + "kindString": "Parameter", + "name": "raw", + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2172, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "bytes | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bytes" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n" + } + ] + }, + "decorations": [ + { + "name": "contextmanager" + } + ], + "flags": {}, + "groups": [], + "id": 2173, + "module": "_resource_clients.log", + "name": "stream", + "parsedDocstring": { + "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n", + "args": { + "raw": "If true, the log will include formatting. For example, coloring character sequences.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved log as a context-managed streaming `Response`, or None, if it does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 95 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved log as a context-managed streaming `Response`, or None, if it does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n" + } + ] + }, + "flags": {}, + "id": 2174, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "stream", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the log will include formatting. For example, coloring character sequences." + } + ] + }, + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2175, + "kind": 32768, + "kindString": "Parameter", + "name": "raw", + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2176, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "HttpResponse", + "target": "1805" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3994, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific log.\n\nProvides methods to manage logs, e.g. get or stream them. Obtain an instance via an appropriate method on the\n`ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2161, + 2165, + 2169, + 2173 + ], + "title": "Methods" + }, + { + "children": [ + 3994 + ], + "title": "Properties" + } + ], + "id": 2160, + "module": "_resource_clients.log", + "name": "LogClient", + "parsedDocstring": { + "text": "Sub-client for managing a specific log.\n\nProvides methods to manage logs, e.g. get or stream them. Obtain an instance via an appropriate method on the\n`ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 19 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2178, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 134 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n404s collapse to `None` only when this client targets a specific log by ID (e.g. `client.log(run_id).get()`).\nFor chained clients without a `resource_id` (e.g. `run.log().get()`), a 404 is ambiguous and propagates.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2182, + "module": "_resource_clients.log", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n404s collapse to `None` only when this client targets a specific log by ID (e.g. `client.log(run_id).get()`).\nFor chained clients without a `resource_id` (e.g. `run.log().get()`), a 404 is ambiguous and propagates.\n", + "args": { + "raw": "If true, the log will include formatting. For example, coloring character sequences.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved log, or None, if it does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 145 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved log, or None, if it does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as text.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n\n404s collapse to `None` only when this client targets a specific log by ID (e.g. `client.log(run_id).get()`).\nFor chained clients without a `resource_id` (e.g. `run.log().get()`), a 404 is ambiguous and propagates.\n" + } + ] + }, + "flags": {}, + "id": 2183, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the log will include formatting. For example, coloring character sequences." + } + ] + }, + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2184, + "kind": 32768, + "kindString": "Parameter", + "name": "raw", + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2185, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2186, + "module": "_resource_clients.log", + "name": "get_as_bytes", + "parsedDocstring": { + "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n", + "args": { + "raw": "If true, the log will include formatting. For example, coloring character sequences.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved log as raw bytes, or None, if it does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 175 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved log as raw bytes, or None, if it does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n" + } + ] + }, + "flags": {}, + "id": 2187, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_as_bytes", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the log will include formatting. For example, coloring character sequences." + } + ] + }, + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2188, + "kind": 32768, + "kindString": "Parameter", + "name": "raw", + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2189, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "bytes | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bytes" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n" + } + ] + }, + "decorations": [ + { + "name": "asynccontextmanager" + } + ], + "flags": {}, + "groups": [], + "id": 2190, + "module": "_resource_clients.log", + "name": "stream", + "parsedDocstring": { + "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n", + "args": { + "raw": "If true, the log will include formatting. For example, coloring character sequences.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved log as a context-managed streaming `Response`, or None, if it does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 203 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved log as a context-managed streaming `Response`, or None, if it does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n" + } + ] + }, + "flags": {}, + "id": 2191, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "stream", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the log will include formatting. For example, coloring character sequences." + } + ] + }, + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2192, + "kind": 32768, + "kindString": "Parameter", + "name": "raw", + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2193, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "HttpResponse", + "target": "1805" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3967, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific log.\n\nProvides methods to manage logs, e.g. get or stream them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2178, + 2182, + 2186, + 2190 + ], + "title": "Methods" + }, + { + "children": [ + 3967 + ], + "title": "Properties" + } + ], + "id": 2177, + "module": "_resource_clients.log", + "name": "LogClientAsync", + "parsedDocstring": { + "text": "Sub-client for managing a specific log.\n\nProvides methods to manage logs, e.g. get or stream them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/log.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 127 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2195, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 23 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available Actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2199, + "module": "_resource_clients.actor_env_var_collection", + "name": "list", + "parsedDocstring": { + "text": "List the available Actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available Actor environment variables." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 34 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available Actor environment variables." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the available Actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n" + } + ] + }, + "flags": {}, + "id": 2200, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2201, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfEnvVars", + "type": "reference", + "target": "657" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available Actor environment variables.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to define more\nenvironment variables than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2202, + "module": "_resource_clients.actor_env_var_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over the available Actor environment variables.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to define more\nenvironment variables than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 48 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available Actor environment variables.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to define more\nenvironment variables than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n" + } + ] + }, + "flags": {}, + "id": 2203, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2204, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "EnvVar", + "target": "541" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2205, + "module": "_resource_clients.actor_env_var_collection", + "name": "create", + "parsedDocstring": { + "text": "Create a new Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n", + "args": { + "is_secret": "Whether the environment variable is secret or not.", + "name": "The name of the environment variable.", + "value": "The value of the environment variable.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The created Actor environment variable." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 66 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The created Actor environment variable." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Create a new Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n" + } + ] + }, + "flags": {}, + "id": 2206, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "create", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the environment variable is secret or not." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2207, + "kind": 32768, + "kindString": "Parameter", + "name": "is_secret", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the environment variable." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 2208, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the environment variable." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 2209, + "kind": 32768, + "kindString": "Parameter", + "name": "value", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2210, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "EnvVar", + "type": "reference", + "target": "541" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3995, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the Actor environment variable collection.\n\nProvides methods to manage Actor environment variables, e.g. list or create them. Obtain an instance via an\nappropriate method on the `ActorVersionClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2195, + 2205, + 2202, + 2199 + ], + "title": "Methods" + }, + { + "children": [ + 3995 + ], + "title": "Properties" + } + ], + "id": 2194, + "module": "_resource_clients.actor_env_var_collection", + "name": "ActorEnvVarCollectionClient", + "parsedDocstring": { + "text": "Sub-client for the Actor environment variable collection.\n\nProvides methods to manage Actor environment variables, e.g. list or create them. Obtain an instance via an\nappropriate method on the `ActorVersionClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 16 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2212, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 102 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available Actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2216, + "module": "_resource_clients.actor_env_var_collection", + "name": "list", + "parsedDocstring": { + "text": "List the available Actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available Actor environment variables." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 113 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available Actor environment variables." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the available Actor environment variables.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n" + } + ] + }, + "flags": {}, + "id": 2217, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2218, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfEnvVars", + "type": "reference", + "target": "657" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available Actor environment variables.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to define more\nenvironment variables than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2219, + "module": "_resource_clients.actor_env_var_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over the available Actor environment variables.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to define more\nenvironment variables than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 127 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available Actor environment variables.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to define more\nenvironment variables than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/get-list-of-environment-variables\n" + } + ] + }, + "flags": {}, + "id": 2220, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2221, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "EnvVar", + "target": "541" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2222, + "module": "_resource_clients.actor_env_var_collection", + "name": "create", + "parsedDocstring": { + "text": "Create a new Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n", + "args": { + "is_secret": "Whether the environment variable is secret or not.", + "name": "The name of the environment variable.", + "value": "The value of the environment variable.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The created Actor environment variable." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 146 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The created Actor environment variable." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Create a new Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-collection/create-environment-variable\n" + } + ] + }, + "flags": {}, + "id": 2223, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "create", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the environment variable is secret or not." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2224, + "kind": 32768, + "kindString": "Parameter", + "name": "is_secret", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the environment variable." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 2225, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the environment variable." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 2226, + "kind": 32768, + "kindString": "Parameter", + "name": "value", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2227, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "EnvVar", + "type": "reference", + "target": "541" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3968, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the Actor environment variable collection.\n\nProvides methods to manage Actor environment variables, e.g. list or create them. Obtain an instance via an\nappropriate method on the `ActorVersionClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2212, + 2222, + 2219, + 2216 + ], + "title": "Methods" + }, + { + "children": [ + 3968 + ], + "title": "Properties" + } + ], + "id": 2211, + "module": "_resource_clients.actor_env_var_collection", + "name": "ActorEnvVarCollectionClientAsync", + "parsedDocstring": { + "text": "Sub-client for the Actor environment variable collection.\n\nProvides methods to manage Actor environment variables, e.g. list or create them. Obtain an instance via an\nappropriate method on the `ActorVersionClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 95 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2229, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 25 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2233, + "module": "_resource_clients.webhook_dispatch_collection", + "name": "list", + "parsedDocstring": { + "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n", + "args": { + "limit": "How many webhook dispatches to retrieve.", + "offset": "What webhook dispatch to include as first when retrieving the list.", + "desc": "Whether to sort the webhook dispatches in descending order based on the date of their creation.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved webhook dispatches of a user." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 36 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved webhook dispatches of a user." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n" + } + ] + }, + "flags": {}, + "id": 2234, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many webhook dispatches to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2235, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What webhook dispatch to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2236, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the webhook dispatches in descending order based on the date of their creation." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2237, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2238, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfWebhookDispatches", + "type": "reference", + "target": "780" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over all webhook dispatches of a user.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2239, + "module": "_resource_clients.webhook_dispatch_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over all webhook dispatches of a user.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n", + "args": { + "limit": "How many webhook dispatches to retrieve.", + "offset": "What webhook dispatch to include as first when retrieving the list.", + "desc": "Whether to sort the webhook dispatches in descending order based on the date of their creation.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 60 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over all webhook dispatches of a user.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n" + } + ] + }, + "flags": {}, + "id": 2240, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many webhook dispatches to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2241, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What webhook dispatch to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2242, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the webhook dispatches in descending order based on the date of their creation." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2243, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2244, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookDispatch", + "target": "1386" + } + ] + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3996, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the webhook dispatch collection.\n\nProvides methods to manage webhook dispatches, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2229, + 2239, + 2233 + ], + "title": "Methods" + }, + { + "children": [ + 3996 + ], + "title": "Properties" + } + ], + "id": 2228, + "module": "_resource_clients.webhook_dispatch_collection", + "name": "WebhookDispatchCollectionClient", + "parsedDocstring": { + "text": "Sub-client for the webhook dispatch collection.\n\nProvides methods to manage webhook dispatches, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 18 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2246, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 99 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2250, + "module": "_resource_clients.webhook_dispatch_collection", + "name": "list", + "parsedDocstring": { + "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n", + "args": { + "limit": "How many webhook dispatches to retrieve.", + "offset": "What webhook dispatch to include as first when retrieving the list.", + "desc": "Whether to sort the webhook dispatches in descending order based on the date of their creation.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved webhook dispatches of a user." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 110 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved webhook dispatches of a user." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List all webhook dispatches of a user.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n" + } + ] + }, + "flags": {}, + "id": 2251, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many webhook dispatches to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2252, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What webhook dispatch to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2253, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the webhook dispatches in descending order based on the date of their creation." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2254, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2255, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfWebhookDispatches", + "type": "reference", + "target": "780" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over all webhook dispatches of a user.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2256, + "module": "_resource_clients.webhook_dispatch_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over all webhook dispatches of a user.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n", + "args": { + "limit": "How many webhook dispatches to retrieve.", + "offset": "What webhook dispatch to include as first when retrieving the list.", + "desc": "Whether to sort the webhook dispatches in descending order based on the date of their creation.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 134 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over all webhook dispatches of a user.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatches-collection/get-list-of-webhook-dispatches\n" + } + ] + }, + "flags": {}, + "id": 2257, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many webhook dispatches to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2258, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What webhook dispatch to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2259, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the webhook dispatches in descending order based on the date of their creation." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2260, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2261, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookDispatch", + "target": "1386" + } + ] + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3969, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the webhook dispatch collection.\n\nProvides methods to manage webhook dispatches, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2246, + 2256, + 2250 + ], + "title": "Methods" + }, + { + "children": [ + 3969 + ], + "title": "Properties" + } + ], + "id": 2245, + "module": "_resource_clients.webhook_dispatch_collection", + "name": "WebhookDispatchCollectionClientAsync", + "parsedDocstring": { + "text": "Sub-client for the webhook dispatch collection.\n\nProvides methods to manage webhook dispatches, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 92 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2263, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 36 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2267, + "module": "_resource_clients.actor_collection", + "name": "list", + "parsedDocstring": { + "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n", + "args": { + "my": "If True, will return only Actors which the user has created themselves.", + "limit": "How many Actors to list.", + "offset": "What Actor to include as first when retrieving the list.", + "desc": "Whether to sort the Actors in descending order based on their creation date.", + "sort_by": "Field to sort the results by.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available Actors matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 47 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available Actors matching the specified filters." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n" + } + ] + }, + "flags": {}, + "id": 2268, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, will return only Actors which the user has created themselves." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2269, + "kind": 32768, + "kindString": "Parameter", + "name": "my", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many Actors to list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2270, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What Actor to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2271, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the Actors in descending order based on their creation date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2272, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Field to sort the results by." + } + ] + }, + "defaultValue": "'createdAt'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2273, + "kind": 32768, + "kindString": "Parameter", + "name": "sort_by", + "type": { + "name": "Literal['createdAt', 'stats.lastRunStartedAt'] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "createdAt" + }, + { + "type": "literal", + "value": "stats.lastRunStartedAt" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2274, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfActors", + "type": "reference", + "target": "753" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the Actors the user has created or used.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2275, + "module": "_resource_clients.actor_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over the Actors the user has created or used.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n", + "args": { + "my": "If True, will return only Actors which the user has created themselves.", + "limit": "How many Actors to list.", + "offset": "What Actor to include as first when retrieving the list.", + "desc": "Whether to sort the Actors in descending order based on their creation date.", + "sort_by": "Field to sort the results by.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 75 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the Actors the user has created or used.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n" + } + ] + }, + "flags": {}, + "id": 2276, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, will return only Actors which the user has created themselves." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2277, + "kind": 32768, + "kindString": "Parameter", + "name": "my", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many Actors to list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2278, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What Actor to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2279, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the Actors in descending order based on their creation date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2280, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Field to sort the results by." + } + ] + }, + "defaultValue": "'createdAt'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2281, + "kind": 32768, + "kindString": "Parameter", + "name": "sort_by", + "type": { + "name": "Literal['createdAt', 'stats.lastRunStartedAt'] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "createdAt" + }, + { + "type": "literal", + "value": "stats.lastRunStartedAt" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2282, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorShort", + "target": "246" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2283, + "module": "_resource_clients.actor_collection", + "name": "create", + "parsedDocstring": { + "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n", + "args": { + "name": "The name of the Actor.", + "title": "The title of the Actor (human-readable).", + "description": "The description for the Actor.", + "seo_title": "The title of the Actor optimized for search engines.", + "seo_description": "The description of the Actor optimized for search engines.", + "versions": "The list of Actor versions.", + "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.", + "is_public": "Whether the Actor is public.", + "is_deprecated": "Whether the Actor is deprecated.", + "categories": "The categories to which the Actor belongs to.", + "default_run_build": "Tag or number of the build that you want to run by default.", + "default_run_max_items": "Default limit of the number of results that will be returned by runs\nof this Actor, if the Actor is charged per result.", + "default_run_memory_mbytes": "Default amount of memory allocated for the runs of this Actor, in megabytes.", + "default_run_timeout": "Default timeout for the runs of this Actor.", + "example_run_input_body": "Input to be prefilled as default input to new users of this Actor.", + "example_run_input_content_type": "The content type of the example run input.", + "actor_standby_is_enabled": "Whether the Actor Standby is enabled.", + "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.", + "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.", + "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.", + "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.", + "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The created Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 109 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The created Actor." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n" + } + ] + }, + "flags": {}, + "id": 2284, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "create", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the Actor." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 2285, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the Actor (human-readable)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2286, + "kind": 32768, + "kindString": "Parameter", + "name": "title", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description for the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2287, + "kind": 32768, + "kindString": "Parameter", + "name": "description", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the Actor optimized for search engines." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2288, + "kind": 32768, + "kindString": "Parameter", + "name": "seo_title", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the Actor optimized for search engines." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2289, + "kind": 32768, + "kindString": "Parameter", + "name": "seo_description", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of Actor versions." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2290, + "kind": 32768, + "kindString": "Parameter", + "name": "versions", + "type": { + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2291, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Actor is public." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2292, + "kind": 32768, + "kindString": "Parameter", + "name": "is_public", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Actor is deprecated." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2293, + "kind": 32768, + "kindString": "Parameter", + "name": "is_deprecated", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The categories to which the Actor belongs to." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2294, + "kind": 32768, + "kindString": "Parameter", + "name": "categories", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tag or number of the build that you want to run by default." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2295, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default limit of the number of results that will be returned by runs\nof this Actor, if the Actor is charged per result." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2296, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_max_items", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default amount of memory allocated for the runs of this Actor, in megabytes." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2297, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for the runs of this Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2298, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input to be prefilled as default input to new users of this Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2299, + "kind": 32768, + "kindString": "Parameter", + "name": "example_run_input_body", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the example run input." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2300, + "kind": 32768, + "kindString": "Parameter", + "name": "example_run_input_content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Actor Standby is enabled." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2301, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_is_enabled", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2302, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_desired_requests_per_actor_run", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2303, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_max_requests_per_actor_run", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If the Actor run does not receive any requests for this time,\nit will be shut down." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2304, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_idle_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The build tag or number to run when the Actor is in Standby mode." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2305, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The memory in megabytes to use when the Actor is in Standby mode." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2306, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2307, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Actor", + "type": "reference", + "target": "192" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3997, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the Actor collection.\n\nProvides methods to manage the Actor collection, e.g. list or create Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2263, + 2283, + 2275, + 2267 + ], + "title": "Methods" + }, + { + "children": [ + 3997 + ], + "title": "Properties" + } + ], + "id": 2262, + "module": "_resource_clients.actor_collection", + "name": "ActorCollectionClient", + "parsedDocstring": { + "text": "Sub-client for the Actor collection.\n\nProvides methods to manage the Actor collection, e.g. list or create Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 29 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2309, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 215 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2313, + "module": "_resource_clients.actor_collection", + "name": "list", + "parsedDocstring": { + "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n", + "args": { + "my": "If True, will return only Actors which the user has created themselves.", + "limit": "How many Actors to list.", + "offset": "What Actor to include as first when retrieving the list.", + "desc": "Whether to sort the Actors in descending order based on their creation date.", + "sort_by": "Field to sort the results by.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available Actors matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 226 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available Actors matching the specified filters." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the Actors the user has created or used.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n" + } + ] + }, + "flags": {}, + "id": 2314, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, will return only Actors which the user has created themselves." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2315, + "kind": 32768, + "kindString": "Parameter", + "name": "my", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many Actors to list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2316, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What Actor to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2317, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the Actors in descending order based on their creation date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2318, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Field to sort the results by." + } + ] + }, + "defaultValue": "'createdAt'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2319, + "kind": 32768, + "kindString": "Parameter", + "name": "sort_by", + "type": { + "name": "Literal['createdAt', 'stats.lastRunStartedAt'] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "createdAt" + }, + { + "type": "literal", + "value": "stats.lastRunStartedAt" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2320, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfActors", + "type": "reference", + "target": "753" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the Actors the user has created or used.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2321, + "module": "_resource_clients.actor_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over the Actors the user has created or used.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n", + "args": { + "my": "If True, will return only Actors which the user has created themselves.", + "limit": "How many Actors to list.", + "offset": "What Actor to include as first when retrieving the list.", + "desc": "Whether to sort the Actors in descending order based on their creation date.", + "sort_by": "Field to sort the results by.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 254 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the Actors the user has created or used.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/get-list-of-actors\n" + } + ] + }, + "flags": {}, + "id": 2322, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, will return only Actors which the user has created themselves." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2323, + "kind": 32768, + "kindString": "Parameter", + "name": "my", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many Actors to list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2324, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What Actor to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2325, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the Actors in descending order based on their creation date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2326, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Field to sort the results by." + } + ] + }, + "defaultValue": "'createdAt'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2327, + "kind": 32768, + "kindString": "Parameter", + "name": "sort_by", + "type": { + "name": "Literal['createdAt', 'stats.lastRunStartedAt'] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "createdAt" + }, + { + "type": "literal", + "value": "stats.lastRunStartedAt" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2328, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorShort", + "target": "246" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2329, + "module": "_resource_clients.actor_collection", + "name": "create", + "parsedDocstring": { + "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n", + "args": { + "name": "The name of the Actor.", + "title": "The title of the Actor (human-readable).", + "description": "The description for the Actor.", + "seo_title": "The title of the Actor optimized for search engines.", + "seo_description": "The description of the Actor optimized for search engines.", + "versions": "The list of Actor versions.", + "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.", + "is_public": "Whether the Actor is public.", + "is_deprecated": "Whether the Actor is deprecated.", + "categories": "The categories to which the Actor belongs to.", + "default_run_build": "Tag or number of the build that you want to run by default.", + "default_run_max_items": "Default limit of the number of results that will be returned by runs\nof this Actor, if the Actor is charged per result.", + "default_run_memory_mbytes": "Default amount of memory allocated for the runs of this Actor, in megabytes.", + "default_run_timeout": "Default timeout for the runs of this Actor.", + "example_run_input_body": "Input to be prefilled as default input to new users of this Actor.", + "example_run_input_content_type": "The content type of the example run input.", + "actor_standby_is_enabled": "Whether the Actor Standby is enabled.", + "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.", + "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.", + "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.", + "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.", + "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The created Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 288 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The created Actor." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Create a new Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-collection/create-actor\n" + } + ] + }, + "flags": {}, + "id": 2330, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "create", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the Actor." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 2331, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the Actor (human-readable)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2332, + "kind": 32768, + "kindString": "Parameter", + "name": "title", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description for the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2333, + "kind": 32768, + "kindString": "Parameter", + "name": "description", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the Actor optimized for search engines." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2334, + "kind": 32768, + "kindString": "Parameter", + "name": "seo_title", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the Actor optimized for search engines." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2335, + "kind": 32768, + "kindString": "Parameter", + "name": "seo_description", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of Actor versions." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2336, + "kind": 32768, + "kindString": "Parameter", + "name": "versions", + "type": { + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2337, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Actor is public." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2338, + "kind": 32768, + "kindString": "Parameter", + "name": "is_public", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Actor is deprecated." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2339, + "kind": 32768, + "kindString": "Parameter", + "name": "is_deprecated", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The categories to which the Actor belongs to." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2340, + "kind": 32768, + "kindString": "Parameter", + "name": "categories", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tag or number of the build that you want to run by default." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2341, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default limit of the number of results that will be returned by runs\nof this Actor, if the Actor is charged per result." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2342, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_max_items", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default amount of memory allocated for the runs of this Actor, in megabytes." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2343, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for the runs of this Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2344, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input to be prefilled as default input to new users of this Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2345, + "kind": 32768, + "kindString": "Parameter", + "name": "example_run_input_body", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the example run input." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2346, + "kind": 32768, + "kindString": "Parameter", + "name": "example_run_input_content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Actor Standby is enabled." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2347, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_is_enabled", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2348, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_desired_requests_per_actor_run", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2349, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_max_requests_per_actor_run", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If the Actor run does not receive any requests for this time,\nit will be shut down." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2350, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_idle_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The build tag or number to run when the Actor is in Standby mode." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2351, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The memory in megabytes to use when the Actor is in Standby mode." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2352, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2353, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Actor", + "type": "reference", + "target": "192" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3970, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the Actor collection.\n\nProvides methods to manage the Actor collection, e.g. list or create Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2309, + 2329, + 2321, + 2313 + ], + "title": "Methods" + }, + { + "children": [ + 3970 + ], + "title": "Properties" + } + ], + "id": 2308, + "module": "_resource_clients.actor_collection", + "name": "ActorCollectionClientAsync", + "parsedDocstring": { + "text": "Sub-client for the Actor collection.\n\nProvides methods to manage the Actor collection, e.g. list or create Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 208 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2355, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_dispatch.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 21 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2360, + "module": "_resource_clients.webhook_dispatch", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved webhook dispatch, or None if it does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_dispatch.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 34 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved webhook dispatch, or None if it does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n" + } + ] + }, + "flags": {}, + "id": 2361, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2362, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "WebhookDispatch | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "WebhookDispatch", + "target": "1386" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3998, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific webhook dispatch.\n\nProvides methods to manage a specific webhook dispatch, e.g. get its details. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2355, + 2360 + ], + "title": "Methods" + }, + { + "children": [ + 3998 + ], + "title": "Properties" + } + ], + "id": 2354, + "module": "_resource_clients.webhook_dispatch", + "name": "WebhookDispatchClient", + "parsedDocstring": { + "text": "Sub-client for managing a specific webhook dispatch.\n\nProvides methods to manage a specific webhook dispatch, e.g. get its details. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_dispatch.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 14 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2364, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_dispatch.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 59 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2369, + "module": "_resource_clients.webhook_dispatch", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved webhook dispatch, or None if it does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_dispatch.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved webhook dispatch, or None if it does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the webhook dispatch.\n\nhttps://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch\n" + } + ] + }, + "flags": {}, + "id": 2370, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2371, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "WebhookDispatch | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "WebhookDispatch", + "target": "1386" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3971, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific webhook dispatch.\n\nProvides methods to manage a specific webhook dispatch, e.g. get its details. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2364, + 2369 + ], + "title": "Methods" + }, + { + "children": [ + 3971 + ], + "title": "Properties" + } + ], + "id": 2363, + "module": "_resource_clients.webhook_dispatch", + "name": "WebhookDispatchClientAsync", + "parsedDocstring": { + "text": "Sub-client for managing a specific webhook dispatch.\n\nProvides methods to manage a specific webhook dispatch, e.g. get its details. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_dispatch.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 52 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2373, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 30 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2377, + "module": "_resource_clients.key_value_store_collection", + "name": "list", + "parsedDocstring": { + "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n", + "args": { + "unnamed": "Whether to include unnamed key-value stores in the list.", + "limit": "How many key-value stores to retrieve.", + "offset": "What key-value store to include as first when retrieving the list.", + "desc": "Whether to sort the key-value stores in descending order based on their modification date.", + "ownership": "Filter by ownership. `'ownedByMe'` returns only user's own key-value stores,\n`'sharedWithMe'` returns only key-value stores shared with the user.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available key-value stores matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 41 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available key-value stores matching the specified filters." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n" + } + ] + }, + "flags": {}, + "id": 2378, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to include unnamed key-value stores in the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2379, + "kind": 32768, + "kindString": "Parameter", + "name": "unnamed", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many key-value stores to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2380, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What key-value store to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2381, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the key-value stores in descending order based on their modification date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2382, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by ownership. `'ownedByMe'` returns only user's own key-value stores,\n`'sharedWithMe'` returns only key-value stores shared with the user." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2383, + "kind": 32768, + "kindString": "Parameter", + "name": "ownership", + "type": { + "name": "StorageOwnership | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "StorageOwnership", + "target": "1801" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2384, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfKeyValueStores", + "type": "reference", + "target": "762" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available key-value stores.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2385, + "module": "_resource_clients.key_value_store_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over the available key-value stores.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n", + "args": { + "unnamed": "Whether to include unnamed key-value stores in the list.", + "limit": "How many key-value stores to retrieve.", + "offset": "What key-value store to include as first when retrieving the list.", + "desc": "Whether to sort the key-value stores in descending order based on their modification date.", + "ownership": "Filter by ownership. 'ownedByMe' returns only user's own key-value stores,\n'sharedWithMe' returns only key-value stores shared with the user.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 77 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available key-value stores.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n" + } + ] + }, + "flags": {}, + "id": 2386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to include unnamed key-value stores in the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2387, + "kind": 32768, + "kindString": "Parameter", + "name": "unnamed", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many key-value stores to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2388, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What key-value store to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2389, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the key-value stores in descending order based on their modification date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2390, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by ownership. 'ownedByMe' returns only user's own key-value stores,\n'sharedWithMe' returns only key-value stores shared with the user." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2391, + "kind": 32768, + "kindString": "Parameter", + "name": "ownership", + "type": { + "name": "StorageOwnership | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "StorageOwnership", + "target": "1801" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2392, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "KeyValueStore", + "target": "595" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2393, + "module": "_resource_clients.key_value_store_collection", + "name": "get_or_create", + "parsedDocstring": { + "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n", + "args": { + "name": "The name of the key-value store to retrieve or create.", + "schema": "The schema of the key-value store.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved or newly-created key-value store." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 114 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved or newly-created key-value store." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n" + } + ] + }, + "flags": {}, + "id": 2394, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_or_create", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the key-value store to retrieve or create." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2395, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The schema of the key-value store." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2396, + "kind": 32768, + "kindString": "Parameter", + "name": "schema", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2397, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "KeyValueStore", + "type": "reference", + "target": "595" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3999, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the key-value store collection.\n\nProvides methods to manage the key-value store collection, e.g. list or create key-value stores. Obtain an instance\nvia an appropriate method on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2373, + 2393, + 2385, + 2377 + ], + "title": "Methods" + }, + { + "children": [ + 3999 + ], + "title": "Properties" + } + ], + "id": 2372, + "module": "_resource_clients.key_value_store_collection", + "name": "KeyValueStoreCollectionClient", + "parsedDocstring": { + "text": "Sub-client for the key-value store collection.\n\nProvides methods to manage the key-value store collection, e.g. list or create key-value stores. Obtain an instance\nvia an appropriate method on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 23 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2399, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 145 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2403, + "module": "_resource_clients.key_value_store_collection", + "name": "list", + "parsedDocstring": { + "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n", + "args": { + "unnamed": "Whether to include unnamed key-value stores in the list.", + "limit": "How many key-value stores to retrieve.", + "offset": "What key-value store to include as first when retrieving the list.", + "desc": "Whether to sort the key-value stores in descending order based on their modification date.", + "ownership": "Filter by ownership. `'ownedByMe'` returns only user's own key-value stores,\n`'sharedWithMe'` returns only key-value stores shared with the user.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available key-value stores matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 156 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available key-value stores matching the specified filters." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the available key-value stores.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n" + } + ] + }, + "flags": {}, + "id": 2404, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to include unnamed key-value stores in the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2405, + "kind": 32768, + "kindString": "Parameter", + "name": "unnamed", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many key-value stores to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2406, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What key-value store to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2407, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the key-value stores in descending order based on their modification date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2408, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by ownership. `'ownedByMe'` returns only user's own key-value stores,\n`'sharedWithMe'` returns only key-value stores shared with the user." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2409, + "kind": 32768, + "kindString": "Parameter", + "name": "ownership", + "type": { + "name": "StorageOwnership | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "StorageOwnership", + "target": "1801" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2410, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfKeyValueStores", + "type": "reference", + "target": "762" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available key-value stores.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2411, + "module": "_resource_clients.key_value_store_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over the available key-value stores.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n", + "args": { + "unnamed": "Whether to include unnamed key-value stores in the list.", + "limit": "How many key-value stores to retrieve.", + "offset": "What key-value store to include as first when retrieving the list.", + "desc": "Whether to sort the key-value stores in descending order based on their modification date.", + "ownership": "Filter by ownership. 'ownedByMe' returns only user's own key-value stores,\n'sharedWithMe' returns only key-value stores shared with the user.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 192 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available key-value stores.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/get-list-of-key-value-stores\n" + } + ] + }, + "flags": {}, + "id": 2412, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to include unnamed key-value stores in the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2413, + "kind": 32768, + "kindString": "Parameter", + "name": "unnamed", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many key-value stores to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2414, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What key-value store to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2415, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the key-value stores in descending order based on their modification date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2416, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by ownership. 'ownedByMe' returns only user's own key-value stores,\n'sharedWithMe' returns only key-value stores shared with the user." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2417, + "kind": 32768, + "kindString": "Parameter", + "name": "ownership", + "type": { + "name": "StorageOwnership | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "StorageOwnership", + "target": "1801" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2418, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "KeyValueStore", + "target": "595" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2419, + "module": "_resource_clients.key_value_store_collection", + "name": "get_or_create", + "parsedDocstring": { + "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n", + "args": { + "name": "The name of the key-value store to retrieve or create.", + "schema": "The schema of the key-value store.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved or newly-created key-value store." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 229 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved or newly-created key-value store." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve a named key-value store, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-collection/create-key-value-store\n" + } + ] + }, + "flags": {}, + "id": 2420, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_or_create", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the key-value store to retrieve or create." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2421, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The schema of the key-value store." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2422, + "kind": 32768, + "kindString": "Parameter", + "name": "schema", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2423, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "KeyValueStore", + "type": "reference", + "target": "595" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3972, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the key-value store collection.\n\nProvides methods to manage the key-value store collection, e.g. list or create key-value stores. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2399, + 2419, + 2411, + 2403 + ], + "title": "Methods" + }, + { + "children": [ + 3972 + ], + "title": "Properties" + } + ], + "id": 2398, + "module": "_resource_clients.key_value_store_collection", + "name": "KeyValueStoreCollectionClientAsync", + "parsedDocstring": { + "text": "Sub-client for the key-value store collection.\n\nProvides methods to manage the key-value store collection, e.g. list or create key-value stores. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 138 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2425, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 39 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2430, + "module": "_resource_clients.actor_version", + "name": "get", + "parsedDocstring": { + "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved Actor version data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 52 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved Actor version data." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n" + } + ] + }, + "flags": {}, + "id": 2431, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2432, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Version | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Version", + "target": "1336" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2433, + "module": "_resource_clients.actor_version", + "name": "update", + "parsedDocstring": { + "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n", + "args": { + "build_tag": "Tag that is automatically set to the latest successful build of the current version.", + "env_vars": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure.", + "apply_env_vars_to_build": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process.", + "source_type": "What source type is the Actor version using.", + "source_files": "Source code comprised of multiple files, each an item of the array. Required when\n`source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure.", + "git_repo_url": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`.", + "tarball_url": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`.", + "github_gist_url": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated Actor version." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 68 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated Actor version." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n" + } + ] + }, + "flags": {}, + "id": 2434, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tag that is automatically set to the latest successful build of the current version." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2435, + "kind": 32768, + "kindString": "Parameter", + "name": "build_tag", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2436, + "kind": 32768, + "kindString": "Parameter", + "name": "env_vars", + "type": { + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2437, + "kind": 32768, + "kindString": "Parameter", + "name": "apply_env_vars_to_build", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What source type is the Actor version using." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2438, + "kind": 32768, + "kindString": "Parameter", + "name": "source_type", + "type": { + "name": "VersionSourceType | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "VersionSourceType", + "target": "1802" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Source code comprised of multiple files, each an item of the array. Required when\n`source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2439, + "kind": 32768, + "kindString": "Parameter", + "name": "source_files", + "type": { + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2440, + "kind": 32768, + "kindString": "Parameter", + "name": "git_repo_url", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2441, + "kind": 32768, + "kindString": "Parameter", + "name": "tarball_url", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2442, + "kind": 32768, + "kindString": "Parameter", + "name": "github_gist_url", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2443, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Version", + "type": "reference", + "target": "1336" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2444, + "module": "_resource_clients.actor_version", + "name": "delete", + "parsedDocstring": { + "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 118 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version\n" + } + ] + }, + "flags": {}, + "id": 2445, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2446, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the environment variables of this Actor version." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2447, + "module": "_resource_clients.actor_version", + "name": "env_vars", + "parsedDocstring": { + "text": "Retrieve a client for the environment variables of this Actor version." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 128 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the environment variables of this Actor version." + } + ] + }, + "flags": {}, + "id": 2448, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "env_vars", + "parameters": [], + "type": { + "name": "ActorEnvVarCollectionClient", + "type": "reference", + "target": "2194" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified environment variable of this Actor version.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2449, + "module": "_resource_clients.actor_version", + "name": "env_var", + "parsedDocstring": { + "text": "Retrieve the client for the specified environment variable of this Actor version.\n", + "args": { + "env_var_name": "The name of the environment variable for which to retrieve the resource client.\n" + }, + "returns": "The resource client for the specified Actor environment variable." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 132 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The resource client for the specified Actor environment variable." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified environment variable of this Actor version.\n" + } + ] + }, + "flags": {}, + "id": 2450, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "env_var", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the environment variable for which to retrieve the resource client.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2451, + "kind": 32768, + "kindString": "Parameter", + "name": "env_var_name", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "ActorEnvVarClient", + "type": "reference", + "target": "3758" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 4000, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific Actor version.\n\nProvides methods to manage a specific Actor version, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ActorClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2425, + 2444, + 2449, + 2447, + 2430, + 2433 + ], + "title": "Methods" + }, + { + "children": [ + 4000 + ], + "title": "Properties" + } + ], + "id": 2424, + "module": "_resource_clients.actor_version", + "name": "ActorVersionClient", + "parsedDocstring": { + "text": "Sub-client for managing a specific Actor version.\n\nProvides methods to manage a specific Actor version, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ActorClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 32 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2453, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 155 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2458, + "module": "_resource_clients.actor_version", + "name": "get", + "parsedDocstring": { + "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved Actor version data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 168 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved Actor version data." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/get-version\n" + } + ] + }, + "flags": {}, + "id": 2459, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2460, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Version | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Version", + "target": "1336" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2461, + "module": "_resource_clients.actor_version", + "name": "update", + "parsedDocstring": { + "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n", + "args": { + "build_tag": "Tag that is automatically set to the latest successful build of the current version.", + "env_vars": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure.", + "apply_env_vars_to_build": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process.", + "source_type": "What source type is the Actor version using.", + "source_files": "Source code comprised of multiple files, each an item of the array. Required when\n`source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure.", + "git_repo_url": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`.", + "tarball_url": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`.", + "github_gist_url": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated Actor version." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 184 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated Actor version." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the Actor version with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/update-version\n" + } + ] + }, + "flags": {}, + "id": 2462, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tag that is automatically set to the latest successful build of the current version." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2463, + "kind": 32768, + "kindString": "Parameter", + "name": "build_tag", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2464, + "kind": 32768, + "kindString": "Parameter", + "name": "env_vars", + "type": { + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2465, + "kind": 32768, + "kindString": "Parameter", + "name": "apply_env_vars_to_build", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What source type is the Actor version using." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2466, + "kind": 32768, + "kindString": "Parameter", + "name": "source_type", + "type": { + "name": "VersionSourceType | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "VersionSourceType", + "target": "1802" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Source code comprised of multiple files, each an item of the array. Required when\n`source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2467, + "kind": 32768, + "kindString": "Parameter", + "name": "source_files", + "type": { + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2468, + "kind": 32768, + "kindString": "Parameter", + "name": "git_repo_url", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2469, + "kind": 32768, + "kindString": "Parameter", + "name": "tarball_url", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2470, + "kind": 32768, + "kindString": "Parameter", + "name": "github_gist_url", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2471, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Version", + "type": "reference", + "target": "1336" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2472, + "module": "_resource_clients.actor_version", + "name": "delete", + "parsedDocstring": { + "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 234 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-object/delete-version\n" + } + ] + }, + "flags": {}, + "id": 2473, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2474, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the environment variables of this Actor version." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2475, + "module": "_resource_clients.actor_version", + "name": "env_vars", + "parsedDocstring": { + "text": "Retrieve a client for the environment variables of this Actor version." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 244 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the environment variables of this Actor version." + } + ] + }, + "flags": {}, + "id": 2476, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "env_vars", + "parameters": [], + "type": { + "name": "ActorEnvVarCollectionClientAsync", + "type": "reference", + "target": "2211" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified environment variable of this Actor version.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2477, + "module": "_resource_clients.actor_version", + "name": "env_var", + "parsedDocstring": { + "text": "Retrieve the client for the specified environment variable of this Actor version.\n", + "args": { + "env_var_name": "The name of the environment variable for which to retrieve the resource client.\n" + }, + "returns": "The resource client for the specified Actor environment variable." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 248 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The resource client for the specified Actor environment variable." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified environment variable of this Actor version.\n" + } + ] + }, + "flags": {}, + "id": 2478, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "env_var", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the environment variable for which to retrieve the resource client.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2479, + "kind": 32768, + "kindString": "Parameter", + "name": "env_var_name", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "ActorEnvVarClientAsync", + "type": "reference", + "target": "3776" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3973, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific Actor version.\n\nProvides methods to manage a specific Actor version, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ActorClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2453, + 2472, + 2477, + 2475, + 2458, + 2461 + ], + "title": "Methods" + }, + { + "children": [ + 3973 + ], + "title": "Properties" + } + ], + "id": 2452, + "module": "_resource_clients.actor_version", + "name": "ActorVersionClientAsync", + "parsedDocstring": { + "text": "Sub-client for managing a specific Actor version.\n\nProvides methods to manage a specific Actor version, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ActorClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 148 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2481, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 31 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2485, + "module": "_resource_clients.request_queue_collection", + "name": "list", + "parsedDocstring": { + "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n", + "args": { + "unnamed": "Whether to include unnamed request queues in the list.", + "limit": "How many request queues to retrieve.", + "offset": "What request queue to include as first when retrieving the list.", + "desc": "Whether to sort the request queues in descending order based on their modification date.", + "ownership": "Filter by ownership. `'ownedByMe'` returns only user's own request queues,\n`'sharedWithMe'` returns only request queues shared with the user.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available request queues matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 42 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available request queues matching the specified filters." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n" + } + ] + }, + "flags": {}, + "id": 2486, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to include unnamed request queues in the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2487, + "kind": 32768, + "kindString": "Parameter", + "name": "unnamed", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many request queues to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2488, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What request queue to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2489, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the request queues in descending order based on their modification date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2490, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by ownership. `'ownedByMe'` returns only user's own request queues,\n`'sharedWithMe'` returns only request queues shared with the user." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2491, + "kind": 32768, + "kindString": "Parameter", + "name": "ownership", + "type": { + "name": "StorageOwnership | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "StorageOwnership", + "target": "1801" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2492, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfRequestQueues", + "type": "reference", + "target": "765" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available request queues.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2493, + "module": "_resource_clients.request_queue_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over the available request queues.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n", + "args": { + "unnamed": "Whether to include unnamed request queues in the list.", + "limit": "How many request queues to retrieve.", + "offset": "What request queue to include as first when retrieving the list.", + "desc": "Whether to sort the request queues in descending order based on their modification date.", + "ownership": "Filter by ownership. 'ownedByMe' returns only user's own request queues,\n'sharedWithMe' returns only request queues shared with the user.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 78 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available request queues.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n" + } + ] + }, + "flags": {}, + "id": 2494, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to include unnamed request queues in the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2495, + "kind": 32768, + "kindString": "Parameter", + "name": "unnamed", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many request queues to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2496, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What request queue to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2497, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the request queues in descending order based on their modification date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2498, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by ownership. 'ownedByMe' returns only user's own request queues,\n'sharedWithMe' returns only request queues shared with the user." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2499, + "kind": 32768, + "kindString": "Parameter", + "name": "ownership", + "type": { + "name": "StorageOwnership | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "StorageOwnership", + "target": "1801" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2500, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "RequestQueueShort", + "target": "922" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2501, + "module": "_resource_clients.request_queue_collection", + "name": "get_or_create", + "parsedDocstring": { + "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n", + "args": { + "name": "The name of the request queue to retrieve or create.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved or newly-created request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 115 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved or newly-created request queue." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n" + } + ] + }, + "flags": {}, + "id": 2502, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_or_create", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the request queue to retrieve or create." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2503, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2504, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "RequestQueue", + "type": "reference", + "target": "898" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 4001, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the request queue collection.\n\nProvides methods to manage the request queue collection, e.g. list or create request queues. Obtain an instance\nvia an appropriate method on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2481, + 2501, + 2493, + 2485 + ], + "title": "Methods" + }, + { + "children": [ + 4001 + ], + "title": "Properties" + } + ], + "id": 2480, + "module": "_resource_clients.request_queue_collection", + "name": "RequestQueueCollectionClient", + "parsedDocstring": { + "text": "Sub-client for the request queue collection.\n\nProvides methods to manage the request queue collection, e.g. list or create request queues. Obtain an instance\nvia an appropriate method on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 24 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2506, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 144 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2510, + "module": "_resource_clients.request_queue_collection", + "name": "list", + "parsedDocstring": { + "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n", + "args": { + "unnamed": "Whether to include unnamed request queues in the list.", + "limit": "How many request queues to retrieve.", + "offset": "What request queue to include as first when retrieving the list.", + "desc": "Whether to sort the request queues in descending order based on their modification date.", + "ownership": "Filter by ownership. `'ownedByMe'` returns only user's own request queues,\n`'sharedWithMe'` returns only request queues shared with the user.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available request queues matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 155 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available request queues matching the specified filters." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the available request queues.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n" + } + ] + }, + "flags": {}, + "id": 2511, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to include unnamed request queues in the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2512, + "kind": 32768, + "kindString": "Parameter", + "name": "unnamed", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many request queues to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2513, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What request queue to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2514, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the request queues in descending order based on their modification date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2515, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by ownership. `'ownedByMe'` returns only user's own request queues,\n`'sharedWithMe'` returns only request queues shared with the user." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2516, + "kind": 32768, + "kindString": "Parameter", + "name": "ownership", + "type": { + "name": "StorageOwnership | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "StorageOwnership", + "target": "1801" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2517, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfRequestQueues", + "type": "reference", + "target": "765" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available request queues.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2518, + "module": "_resource_clients.request_queue_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over the available request queues.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n", + "args": { + "unnamed": "Whether to include unnamed request queues in the list.", + "limit": "How many request queues to retrieve.", + "offset": "What request queue to include as first when retrieving the list.", + "desc": "Whether to sort the request queues in descending order based on their modification date.", + "ownership": "Filter by ownership. 'ownedByMe' returns only user's own request queues,\n'sharedWithMe' returns only request queues shared with the user.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 191 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available request queues.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues\n" + } + ] + }, + "flags": {}, + "id": 2519, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to include unnamed request queues in the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2520, + "kind": 32768, + "kindString": "Parameter", + "name": "unnamed", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many request queues to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2521, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What request queue to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2522, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the request queues in descending order based on their modification date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2523, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by ownership. 'ownedByMe' returns only user's own request queues,\n'sharedWithMe' returns only request queues shared with the user." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2524, + "kind": 32768, + "kindString": "Parameter", + "name": "ownership", + "type": { + "name": "StorageOwnership | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "StorageOwnership", + "target": "1801" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2525, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "RequestQueueShort", + "target": "922" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2526, + "module": "_resource_clients.request_queue_collection", + "name": "get_or_create", + "parsedDocstring": { + "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n", + "args": { + "name": "The name of the request queue to retrieve or create.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved or newly-created request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 228 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved or newly-created request queue." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve a named request queue, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/request-queues/queue-collection/create-request-queue\n" + } + ] + }, + "flags": {}, + "id": 2527, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_or_create", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the request queue to retrieve or create." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2528, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2529, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "RequestQueue", + "type": "reference", + "target": "898" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3974, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the request queue collection.\n\nProvides methods to manage the request queue collection, e.g. list or create request queues. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2506, + 2526, + 2518, + 2510 + ], + "title": "Methods" + }, + { + "children": [ + 3974 + ], + "title": "Properties" + } + ], + "id": 2505, + "module": "_resource_clients.request_queue_collection", + "name": "RequestQueueCollectionClientAsync", + "parsedDocstring": { + "text": "Sub-client for the request queue collection.\n\nProvides methods to manage the request queue collection, e.g. list or create request queues. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/request_queue_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 137 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2531, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 37 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2535, + "module": "_resource_clients.task_collection", + "name": "list", + "parsedDocstring": { + "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n", + "args": { + "limit": "How many tasks to list.", + "offset": "What task to include as first when retrieving the list.", + "desc": "Whether to sort the tasks in descending order based on their creation date.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available tasks matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 48 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available tasks matching the specified filters." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n" + } + ] + }, + "flags": {}, + "id": 2536, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many tasks to list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2537, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What task to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2538, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the tasks in descending order based on their creation date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2539, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2540, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfTasks", + "type": "reference", + "target": "777" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available tasks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2541, + "module": "_resource_clients.task_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over the available tasks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n", + "args": { + "limit": "How many tasks to list.", + "offset": "What task to include as first when retrieving the list.", + "desc": "Whether to sort the tasks in descending order based on their creation date.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available tasks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n" + } + ] + }, + "flags": {}, + "id": 2542, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many tasks to list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2543, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What task to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2544, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the tasks in descending order based on their creation date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2545, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2546, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "TaskShort", + "target": "1226" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2547, + "module": "_resource_clients.task_collection", + "name": "create", + "parsedDocstring": { + "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n", + "args": { + "actor_id": "Id of the Actor that should be run.", + "name": "Name of the task.", + "build": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest).", + "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.", + "max_items": "Maximum number of results that will be returned by runs of this task. If the Actor of this task\nis charged per result, you will not be charged for more results than the given limit.", + "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.", + "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.", + "task_input": "Task input object.", + "title": "A human-friendly equivalent of the name.", + "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.", + "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.", + "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.", + "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.", + "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The created task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 102 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The created task." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n" + } + ] + }, + "flags": {}, + "id": 2548, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "create", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Id of the Actor that should be run." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 2549, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the task." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 2550, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2551, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2552, + "kind": 32768, + "kindString": "Parameter", + "name": "run_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2553, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of results that will be returned by runs of this task. If the Actor of this task\nis charged per result, you will not be charged for more results than the given limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2554, + "kind": 32768, + "kindString": "Parameter", + "name": "max_items", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2555, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Task input object." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2556, + "kind": 32768, + "kindString": "Parameter", + "name": "task_input", + "type": { + "name": "TaskInputDict | TaskInput | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict[str, Any]" + }, + { + "type": "reference", + "name": "TaskInput", + "target": "1213" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A human-friendly equivalent of the name." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2557, + "kind": 32768, + "kindString": "Parameter", + "name": "title", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2558, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_desired_requests_per_actor_run", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2559, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_max_requests_per_actor_run", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If the Actor run does not receive any requests for this time,\nit will be shut down." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2560, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_idle_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The build tag or number to run when the Actor is in Standby mode." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2561, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The memory in megabytes to use when the Actor is in Standby mode." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2562, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2563, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Task", + "type": "reference", + "target": "1197" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 4002, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the task collection.\n\nProvides methods to manage the task collection, e.g. list or create tasks. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2531, + 2547, + 2541, + 2535 + ], + "title": "Methods" + }, + { + "children": [ + 4002 + ], + "title": "Properties" + } + ], + "id": 2530, + "module": "_resource_clients.task_collection", + "name": "TaskCollectionClient", + "parsedDocstring": { + "text": "Sub-client for the task collection.\n\nProvides methods to manage the task collection, e.g. list or create tasks. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 30 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2565, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 188 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2569, + "module": "_resource_clients.task_collection", + "name": "list", + "parsedDocstring": { + "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n", + "args": { + "limit": "How many tasks to list.", + "offset": "What task to include as first when retrieving the list.", + "desc": "Whether to sort the tasks in descending order based on their creation date.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available tasks matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 199 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available tasks matching the specified filters." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the available tasks.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n" + } + ] + }, + "flags": {}, + "id": 2570, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many tasks to list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2571, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What task to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2572, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the tasks in descending order based on their creation date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2573, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2574, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfTasks", + "type": "reference", + "target": "777" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available tasks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2575, + "module": "_resource_clients.task_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over the available tasks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n", + "args": { + "limit": "How many tasks to list.", + "offset": "What task to include as first when retrieving the list.", + "desc": "Whether to sort the tasks in descending order based on their creation date.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 223 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available tasks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/get-list-of-tasks\n" + } + ] + }, + "flags": {}, + "id": 2576, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many tasks to list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2577, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What task to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2578, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the tasks in descending order based on their creation date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2579, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2580, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "TaskShort", + "target": "1226" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2581, + "module": "_resource_clients.task_collection", + "name": "create", + "parsedDocstring": { + "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n", + "args": { + "actor_id": "Id of the Actor that should be run.", + "name": "Name of the task.", + "build": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest).", + "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.", + "max_items": "Maximum number of results that will be returned by runs of this task. If the Actor of this task\nis charged per result, you will not be charged for more results than the given limit.", + "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.", + "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.", + "task_input": "Task input object.", + "title": "A human-friendly equivalent of the name.", + "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.", + "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.", + "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.", + "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.", + "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The created task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 253 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The created task." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Create a new task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-collection/create-task\n" + } + ] + }, + "flags": {}, + "id": 2582, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "create", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Id of the Actor that should be run." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 2583, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the task." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 2584, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2585, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2586, + "kind": 32768, + "kindString": "Parameter", + "name": "run_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2587, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of results that will be returned by runs of this task. If the Actor of this task\nis charged per result, you will not be charged for more results than the given limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2588, + "kind": 32768, + "kindString": "Parameter", + "name": "max_items", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2589, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Task input object." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2590, + "kind": 32768, + "kindString": "Parameter", + "name": "task_input", + "type": { + "name": "TaskInputDict | TaskInput | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict[str, Any]" + }, + { + "type": "reference", + "name": "TaskInput", + "target": "1213" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A human-friendly equivalent of the name." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2591, + "kind": 32768, + "kindString": "Parameter", + "name": "title", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2592, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_desired_requests_per_actor_run", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2593, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_max_requests_per_actor_run", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If the Actor run does not receive any requests for this time,\nit will be shut down." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2594, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_idle_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The build tag or number to run when the Actor is in Standby mode." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2595, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The memory in megabytes to use when the Actor is in Standby mode." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2596, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2597, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Task", + "type": "reference", + "target": "1197" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3975, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the task collection.\n\nProvides methods to manage the task collection, e.g. list or create tasks. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2565, + 2581, + 2575, + 2569 + ], + "title": "Methods" + }, + { + "children": [ + 3975 + ], + "title": "Properties" + } + ], + "id": 2564, + "module": "_resource_clients.task_collection", + "name": "TaskCollectionClientAsync", + "parsedDocstring": { + "text": "Sub-client for the task collection.\n\nProvides methods to manage the task collection, e.g. list or create tasks. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 181 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2599, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/store_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 25 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2603, + "module": "_resource_clients.store_collection", + "name": "list", + "parsedDocstring": { + "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n", + "args": { + "limit": "How many Actors to list.", + "offset": "What Actor to include as first when retrieving the list.", + "search": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme.", + "sort_by": "Specifies the field by which to sort the results.", + "category": "Filter by this category.", + "username": "Filter by this username.", + "pricing_model": "Filter by this pricing model.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available Actors matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/store_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 36 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available Actors matching the specified filters." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n" + } + ] + }, + "flags": {}, + "id": 2604, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many Actors to list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2605, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What Actor to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2606, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2607, + "kind": 32768, + "kindString": "Parameter", + "name": "search", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the field by which to sort the results." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2608, + "kind": 32768, + "kindString": "Parameter", + "name": "sort_by", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by this category." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2609, + "kind": 32768, + "kindString": "Parameter", + "name": "category", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by this username." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2610, + "kind": 32768, + "kindString": "Parameter", + "name": "username", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by this pricing model." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2611, + "kind": 32768, + "kindString": "Parameter", + "name": "pricing_model", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2612, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfStoreActors", + "type": "reference", + "target": "774" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over Actors in Apify store.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2613, + "module": "_resource_clients.store_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over Actors in Apify store.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n", + "args": { + "limit": "How many Actors to list.", + "offset": "What Actor to include as first when retrieving the list.", + "search": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme.", + "sort_by": "Specifies the field by which to sort the results.", + "category": "Filter by this category.", + "username": "Filter by this username.", + "pricing_model": "Filter by this pricing model.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/store_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 78 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over Actors in Apify store.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n" + } + ] + }, + "flags": {}, + "id": 2614, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many Actors to list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2615, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What Actor to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2616, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2617, + "kind": 32768, + "kindString": "Parameter", + "name": "search", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the field by which to sort the results." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2618, + "kind": 32768, + "kindString": "Parameter", + "name": "sort_by", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by this category." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2619, + "kind": 32768, + "kindString": "Parameter", + "name": "category", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by this username." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2620, + "kind": 32768, + "kindString": "Parameter", + "name": "username", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by this pricing model." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2621, + "kind": 32768, + "kindString": "Parameter", + "name": "pricing_model", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2622, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "StoreListActor", + "target": "1175" + } + ] + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 4003, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the Apify store collection.\n\nProvides methods to browse the Apify store, e.g. list available Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2599, + 2613, + 2603 + ], + "title": "Methods" + }, + { + "children": [ + 4003 + ], + "title": "Properties" + } + ], + "id": 2598, + "module": "_resource_clients.store_collection", + "name": "StoreCollectionClient", + "parsedDocstring": { + "text": "Sub-client for the Apify store collection.\n\nProvides methods to browse the Apify store, e.g. list available Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/store_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 18 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2624, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/store_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 135 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2628, + "module": "_resource_clients.store_collection", + "name": "list", + "parsedDocstring": { + "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n", + "args": { + "limit": "How many Actors to list.", + "offset": "What Actor to include as first when retrieving the list.", + "search": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme.", + "sort_by": "Specifies the field by which to sort the results.", + "category": "Filter by this category.", + "username": "Filter by this username.", + "pricing_model": "Filter by this pricing model.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available Actors matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/store_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 146 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available Actors matching the specified filters." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List Actors in Apify store.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n" + } + ] + }, + "flags": {}, + "id": 2629, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many Actors to list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2630, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What Actor to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2631, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2632, + "kind": 32768, + "kindString": "Parameter", + "name": "search", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the field by which to sort the results." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2633, + "kind": 32768, + "kindString": "Parameter", + "name": "sort_by", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by this category." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2634, + "kind": 32768, + "kindString": "Parameter", + "name": "category", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by this username." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2635, + "kind": 32768, + "kindString": "Parameter", + "name": "username", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by this pricing model." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2636, + "kind": 32768, + "kindString": "Parameter", + "name": "pricing_model", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2637, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfStoreActors", + "type": "reference", + "target": "774" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over Actors in Apify store.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2638, + "module": "_resource_clients.store_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over Actors in Apify store.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n", + "args": { + "limit": "How many Actors to list.", + "offset": "What Actor to include as first when retrieving the list.", + "search": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme.", + "sort_by": "Specifies the field by which to sort the results.", + "category": "Filter by this category.", + "username": "Filter by this username.", + "pricing_model": "Filter by this pricing model.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/store_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 188 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over Actors in Apify store.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2/#/reference/store/store-actors-collection/get-list-of-actors-in-store\n" + } + ] + }, + "flags": {}, + "id": 2639, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many Actors to list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2640, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What Actor to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2641, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "String to search by. The search runs on the following fields: title, name, description, username,\nreadme." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2642, + "kind": 32768, + "kindString": "Parameter", + "name": "search", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the field by which to sort the results." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2643, + "kind": 32768, + "kindString": "Parameter", + "name": "sort_by", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by this category." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2644, + "kind": 32768, + "kindString": "Parameter", + "name": "category", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by this username." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2645, + "kind": 32768, + "kindString": "Parameter", + "name": "username", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by this pricing model." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2646, + "kind": 32768, + "kindString": "Parameter", + "name": "pricing_model", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2647, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "StoreListActor", + "target": "1175" + } + ] + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3976, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the Apify store collection.\n\nProvides methods to browse the Apify store, e.g. list available Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2624, + 2638, + 2628 + ], + "title": "Methods" + }, + { + "children": [ + 3976 + ], + "title": "Properties" + } + ], + "id": 2623, + "module": "_resource_clients.store_collection", + "name": "StoreCollectionClientAsync", + "parsedDocstring": { + "text": "Sub-client for the Apify store collection.\n\nProvides methods to browse the Apify store, e.g. list available Actors. Obtain an instance via an appropriate\nmethod on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/store_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 128 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2649, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 43 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2654, + "module": "_resource_clients.task", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 52 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved task." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n" + } + ] + }, + "flags": {}, + "id": 2655, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2656, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Task | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Task", + "target": "1197" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2657, + "module": "_resource_clients.task", + "name": "update", + "parsedDocstring": { + "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n", + "args": { + "name": "Name of the task.", + "build": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest).", + "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit.", + "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.", + "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.", + "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.", + "task_input": "Task input dictionary.", + "title": "A human-friendly equivalent of the name.", + "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.", + "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.", + "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.", + "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.", + "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 68 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated task." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n" + } + ] + }, + "flags": {}, + "id": 2658, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the task." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2659, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Task input dictionary." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2660, + "kind": 32768, + "kindString": "Parameter", + "name": "task_input", + "type": { + "name": "TaskInputDict | TaskInput | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict[str, Any]" + }, + { + "type": "reference", + "name": "TaskInput", + "target": "1213" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2661, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2662, + "kind": 32768, + "kindString": "Parameter", + "name": "max_items", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2663, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2664, + "kind": 32768, + "kindString": "Parameter", + "name": "run_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2665, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A human-friendly equivalent of the name." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2666, + "kind": 32768, + "kindString": "Parameter", + "name": "title", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2667, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_desired_requests_per_actor_run", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2668, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_max_requests_per_actor_run", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If the Actor run does not receive any requests for this time,\nit will be shut down." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2669, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_idle_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The build tag or number to run when the Actor is in Standby mode." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2670, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The memory in megabytes to use when the Actor is in Standby mode." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2671, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2672, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Task", + "type": "reference", + "target": "1197" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2673, + "module": "_resource_clients.task", + "name": "delete", + "parsedDocstring": { + "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 142 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task\n" + } + ] + }, + "flags": {}, + "id": 2674, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2675, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2676, + "module": "_resource_clients.task", + "name": "start", + "parsedDocstring": { + "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n", + "args": { + "task_input": "Task input dictionary.", + "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest).", + "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit.", + "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.", + "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.", + "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.", + "wait_for_finish": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60.", + "webhooks": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The run object." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 152 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The run object." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n" + } + ] + }, + "flags": {}, + "id": 2677, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "start", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Task input dictionary." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2678, + "kind": 32768, + "kindString": "Parameter", + "name": "task_input", + "type": { + "name": "TaskInputDict | TaskInput | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict[str, Any]" + }, + { + "type": "reference", + "name": "TaskInput", + "target": "1213" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2679, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2680, + "kind": 32768, + "kindString": "Parameter", + "name": "max_items", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2681, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2682, + "kind": 32768, + "kindString": "Parameter", + "name": "run_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2683, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2684, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_for_finish", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2685, + "kind": 32768, + "kindString": "Parameter", + "name": "webhooks", + "type": { + "name": "WebhooksList | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "WebhooksList", + "target": "14" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2686, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run", + "type": "reference", + "target": "958" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2687, + "module": "_resource_clients.task", + "name": "call", + "parsedDocstring": { + "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n", + "args": { + "task_input": "Task input dictionary.", + "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest).", + "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit.", + "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.", + "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.", + "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.", + "webhooks": "Specifies optional webhooks associated with the Actor run, which can be used to receive\na notification e.g. when the Actor finished or failed. Note: if you already have a webhook set up for\nthe Actor or task, you do not have to add it again here.", + "wait_duration": "The maximum time the server waits for the task run to finish. If not provided,\nwaits indefinitely.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The run object." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 220 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The run object." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n" + } + ] + }, + "flags": {}, + "id": 2688, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "call", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Task input dictionary." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2689, + "kind": 32768, + "kindString": "Parameter", + "name": "task_input", + "type": { + "name": "TaskInputDict | TaskInput | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict[str, Any]" + }, + { + "type": "reference", + "name": "TaskInput", + "target": "1213" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2690, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2691, + "kind": 32768, + "kindString": "Parameter", + "name": "max_items", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2692, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2693, + "kind": 32768, + "kindString": "Parameter", + "name": "run_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2694, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies optional webhooks associated with the Actor run, which can be used to receive\na notification e.g. when the Actor finished or failed. Note: if you already have a webhook set up for\nthe Actor or task, you do not have to add it again here." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2695, + "kind": 32768, + "kindString": "Parameter", + "name": "webhooks", + "type": { + "name": "WebhooksList | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "WebhooksList", + "target": "14" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum time the server waits for the task run to finish. If not provided,\nwaits indefinitely." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2696, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_duration", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'no_timeout'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2697, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Run", + "target": "958" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2698, + "module": "_resource_clients.task", + "name": "get_input", + "parsedDocstring": { + "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "Retrieved task input." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 281 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Retrieved task input." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n" + } + ] + }, + "flags": {}, + "id": 2699, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_input", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2700, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "dict", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2701, + "module": "_resource_clients.task", + "name": "update_input", + "parsedDocstring": { + "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n", + "args": { + "task_input": "The new default input for this task.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated task input." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 303 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated task input." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n" + } + ] + }, + "flags": {}, + "id": 2702, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "update_input", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new default input for this task." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 2703, + "kind": 32768, + "kindString": "Parameter", + "name": "task_input", + "type": { + "name": "TaskInputDict | TaskInput", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict[str, Any]" + }, + { + "type": "reference", + "name": "TaskInput", + "target": "1213" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2704, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "dict", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this task." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2705, + "module": "_resource_clients.task", + "name": "runs", + "parsedDocstring": { + "text": "Retrieve a client for the runs of this task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 327 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this task." + } + ] + }, + "flags": {}, + "id": 2706, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "runs", + "parameters": [], + "type": { + "name": "RunCollectionClient", + "type": "reference", + "target": "3916" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2707, + "module": "_resource_clients.task", + "name": "last_run", + "parsedDocstring": { + "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n", + "args": { + "status": "Consider only runs with this status.", + "origin": "Consider only runs started with this origin.\n" + }, + "returns": "The resource client for the last run of this task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 334 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The resource client for the last run of this task." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n" + } + ] + }, + "flags": {}, + "id": 2708, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "last_run", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Consider only runs with this status." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2709, + "kind": 32768, + "kindString": "Parameter", + "name": "status", + "type": { + "name": "ActorJobStatus | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorJobStatus", + "target": "1794" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Consider only runs started with this origin.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2710, + "kind": 32768, + "kindString": "Parameter", + "name": "origin", + "type": { + "name": "RunOrigin | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "RunOrigin", + "target": "1799" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "RunClient", + "type": "reference", + "target": "3033" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this task." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2711, + "module": "_resource_clients.task", + "name": "webhooks", + "parsedDocstring": { + "text": "Retrieve a client for webhooks associated with this task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 353 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this task." + } + ] + }, + "flags": {}, + "id": 2712, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "webhooks", + "parameters": [], + "type": { + "name": "WebhookCollectionClient", + "type": "reference", + "target": "3794" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 4004, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific task.\n\nProvides methods to manage a specific task, e.g. update it, delete it, or start runs. Obtain an instance via an\nappropriate method on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2649, + 2687, + 2673, + 2654, + 2698, + 2707, + 2705, + 2676, + 2657, + 2701, + 2711 + ], + "title": "Methods" + }, + { + "children": [ + 4004 + ], + "title": "Properties" + } + ], + "id": 2648, + "module": "_resource_clients.task", + "name": "TaskClient", + "parsedDocstring": { + "text": "Sub-client for managing a specific task.\n\nProvides methods to manage a specific task, e.g. update it, delete it, or start runs. Obtain an instance via an\nappropriate method on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 36 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2714, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 366 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2719, + "module": "_resource_clients.task", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 375 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved task." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/get-task\n" + } + ] + }, + "flags": {}, + "id": 2720, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2721, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Task | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Task", + "target": "1197" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2722, + "module": "_resource_clients.task", + "name": "update", + "parsedDocstring": { + "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n", + "args": { + "name": "Name of the task.", + "build": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest).", + "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit.", + "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.", + "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.", + "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.", + "task_input": "Task input dictionary.", + "title": "A human-friendly equivalent of the name.", + "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.", + "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.", + "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.", + "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.", + "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 391 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated task." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the task with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/update-task\n" + } + ] + }, + "flags": {}, + "id": 2723, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the task." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2724, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Task input dictionary." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2725, + "kind": 32768, + "kindString": "Parameter", + "name": "task_input", + "type": { + "name": "TaskInputDict | TaskInput | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict[str, Any]" + }, + { + "type": "reference", + "name": "TaskInput", + "target": "1213" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor build to run. It can be either a build tag or build number. By default, the run uses\nthe build specified in the task settings (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2726, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2727, + "kind": 32768, + "kindString": "Parameter", + "name": "max_items", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2728, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2729, + "kind": 32768, + "kindString": "Parameter", + "name": "run_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2730, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A human-friendly equivalent of the name." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2731, + "kind": 32768, + "kindString": "Parameter", + "name": "title", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2732, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_desired_requests_per_actor_run", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2733, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_max_requests_per_actor_run", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If the Actor run does not receive any requests for this time,\nit will be shut down." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2734, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_idle_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The build tag or number to run when the Actor is in Standby mode." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2735, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The memory in megabytes to use when the Actor is in Standby mode." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2736, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2737, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Task", + "type": "reference", + "target": "1197" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2738, + "module": "_resource_clients.task", + "name": "delete", + "parsedDocstring": { + "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 465 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task\n" + } + ] + }, + "flags": {}, + "id": 2739, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2740, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2741, + "module": "_resource_clients.task", + "name": "start", + "parsedDocstring": { + "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n", + "args": { + "task_input": "Task input dictionary.", + "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest).", + "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit.", + "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.", + "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.", + "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.", + "wait_for_finish": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60.", + "webhooks": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The run object." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 475 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The run object." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Start the task and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n" + } + ] + }, + "flags": {}, + "id": 2742, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "start", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Task input dictionary." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2743, + "kind": 32768, + "kindString": "Parameter", + "name": "task_input", + "type": { + "name": "TaskInputDict | TaskInput | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict[str, Any]" + }, + { + "type": "reference", + "name": "TaskInput", + "target": "1213" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2744, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2745, + "kind": 32768, + "kindString": "Parameter", + "name": "max_items", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2746, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2747, + "kind": 32768, + "kindString": "Parameter", + "name": "run_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2748, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2749, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_for_finish", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2750, + "kind": 32768, + "kindString": "Parameter", + "name": "webhooks", + "type": { + "name": "WebhooksList | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "WebhooksList", + "target": "14" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2751, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run", + "type": "reference", + "target": "958" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2752, + "module": "_resource_clients.task", + "name": "call", + "parsedDocstring": { + "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n", + "args": { + "task_input": "Task input dictionary.", + "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest).", + "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit.", + "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings.", + "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings.", + "restart_on_error": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code.", + "webhooks": "Specifies optional webhooks associated with the Actor run, which can be used to receive\na notification e.g. when the Actor finished or failed. Note: if you already have a webhook set up for\nthe Actor or task, you do not have to add it again here.", + "wait_duration": "The maximum time the server waits for the task run to finish. If not provided,\nwaits indefinitely.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The run object." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 543 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The run object." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Start a task and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n" + } + ] + }, + "flags": {}, + "id": 2753, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "call", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Task input dictionary." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2754, + "kind": 32768, + "kindString": "Parameter", + "name": "task_input", + "type": { + "name": "TaskInputDict | TaskInput | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict[str, Any]" + }, + { + "type": "reference", + "name": "TaskInput", + "target": "1213" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the task settings (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2755, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of results that will be returned by this run. If the Actor is charged per result,\nyou will not be charged for more results than the given limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2756, + "kind": 32768, + "kindString": "Parameter", + "name": "max_items", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit specified\nin the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2757, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2758, + "kind": 32768, + "kindString": "Parameter", + "name": "run_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Task run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2759, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies optional webhooks associated with the Actor run, which can be used to receive\na notification e.g. when the Actor finished or failed. Note: if you already have a webhook set up for\nthe Actor or task, you do not have to add it again here." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2760, + "kind": 32768, + "kindString": "Parameter", + "name": "webhooks", + "type": { + "name": "WebhooksList | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "WebhooksList", + "target": "14" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum time the server waits for the task run to finish. If not provided,\nwaits indefinitely." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2761, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_duration", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'no_timeout'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2762, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Run", + "target": "958" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2763, + "module": "_resource_clients.task", + "name": "get_input", + "parsedDocstring": { + "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "Retrieved task input." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 603 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "Retrieved task input." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/get-task-input\n" + } + ] + }, + "flags": {}, + "id": 2764, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_input", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2765, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "dict", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2766, + "module": "_resource_clients.task", + "name": "update_input", + "parsedDocstring": { + "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n", + "args": { + "task_input": "The new default input for this task.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated task input." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 625 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated task input." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the default input for this task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-input-object/update-task-input\n" + } + ] + }, + "flags": {}, + "id": 2767, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "update_input", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new default input for this task." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 2768, + "kind": 32768, + "kindString": "Parameter", + "name": "task_input", + "type": { + "name": "TaskInputDict | TaskInput", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict[str, Any]" + }, + { + "type": "reference", + "name": "TaskInput", + "target": "1213" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2769, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "dict", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this task." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2770, + "module": "_resource_clients.task", + "name": "runs", + "parsedDocstring": { + "text": "Retrieve a client for the runs of this task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 649 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this task." + } + ] + }, + "flags": {}, + "id": 2771, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "runs", + "parameters": [], + "type": { + "name": "RunCollectionClientAsync", + "type": "reference", + "target": "3939" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2772, + "module": "_resource_clients.task", + "name": "last_run", + "parsedDocstring": { + "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n", + "args": { + "status": "Consider only runs with this status.", + "origin": "Consider only runs started with this origin.\n" + }, + "returns": "The resource client for the last run of this task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 656 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The resource client for the last run of this task." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the last run of this task.\n\nLast run is retrieved based on the start time of the runs.\n" + } + ] + }, + "flags": {}, + "id": 2773, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "last_run", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Consider only runs with this status." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2774, + "kind": 32768, + "kindString": "Parameter", + "name": "status", + "type": { + "name": "ActorJobStatus | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorJobStatus", + "target": "1794" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Consider only runs started with this origin.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2775, + "kind": 32768, + "kindString": "Parameter", + "name": "origin", + "type": { + "name": "RunOrigin | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "RunOrigin", + "target": "1799" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "RunClientAsync", + "type": "reference", + "target": "3102" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this task." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2776, + "module": "_resource_clients.task", + "name": "webhooks", + "parsedDocstring": { + "text": "Retrieve a client for webhooks associated with this task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 675 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this task." + } + ] + }, + "flags": {}, + "id": 2777, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "webhooks", + "parameters": [], + "type": { + "name": "WebhookCollectionClientAsync", + "type": "reference", + "target": "3825" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3977, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific task.\n\nProvides methods to manage a specific task, e.g. update it, delete it, or start runs. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2714, + 2752, + 2738, + 2719, + 2763, + 2772, + 2770, + 2741, + 2722, + 2766, + 2776 + ], + "title": "Methods" + }, + { + "children": [ + 3977 + ], + "title": "Properties" + } + ], + "id": 2713, + "module": "_resource_clients.task", + "name": "TaskClientAsync", + "parsedDocstring": { + "text": "Sub-client for managing a specific task.\n\nProvides methods to manage a specific task, e.g. update it, delete it, or start runs. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/task.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 359 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2779, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 25 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2783, + "module": "_resource_clients.build_collection", + "name": "list", + "parsedDocstring": { + "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n", + "args": { + "limit": "How many builds to retrieve.", + "offset": "What build to include as first when retrieving the list.", + "desc": "Whether to sort the builds in descending order based on their start date.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved Actor builds." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 36 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved Actor builds." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n" + } + ] + }, + "flags": {}, + "id": 2784, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many builds to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2785, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What build to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2786, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the builds in descending order based on their start date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2787, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2788, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfBuilds", + "type": "reference", + "target": "756" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over all Actor builds.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2789, + "module": "_resource_clients.build_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over all Actor builds.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n", + "args": { + "limit": "How many builds to retrieve.", + "offset": "What build to include as first when retrieving the list.", + "desc": "Whether to sort the builds in descending order based on their start date.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 64 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over all Actor builds.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n" + } + ] + }, + "flags": {}, + "id": 2790, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many builds to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2791, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What build to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2792, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the builds in descending order based on their start date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2793, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2794, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "BuildShort", + "target": "333" + } + ] + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 4005, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the Actor build collection.\n\nProvides methods to manage Actor builds, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2779, + 2789, + 2783 + ], + "title": "Methods" + }, + { + "children": [ + 4005 + ], + "title": "Properties" + } + ], + "id": 2778, + "module": "_resource_clients.build_collection", + "name": "BuildCollectionClient", + "parsedDocstring": { + "text": "Sub-client for the Actor build collection.\n\nProvides methods to manage Actor builds, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 18 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2796, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 104 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2800, + "module": "_resource_clients.build_collection", + "name": "list", + "parsedDocstring": { + "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n", + "args": { + "limit": "How many builds to retrieve.", + "offset": "What build to include as first when retrieving the list.", + "desc": "Whether to sort the builds in descending order based on their start date.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved Actor builds." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 115 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved Actor builds." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List all Actor builds.\n\nList all Actor builds, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n" + } + ] + }, + "flags": {}, + "id": 2801, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many builds to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2802, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What build to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2803, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the builds in descending order based on their start date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2804, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2805, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfBuilds", + "type": "reference", + "target": "756" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over all Actor builds.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2806, + "module": "_resource_clients.build_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over all Actor builds.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n", + "args": { + "limit": "How many builds to retrieve.", + "offset": "What build to include as first when retrieving the list.", + "desc": "Whether to sort the builds in descending order based on their start date.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 143 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over all Actor builds.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/get-list-of-builds\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-collection/get-user-builds-list\n" + } + ] + }, + "flags": {}, + "id": 2807, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many builds to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2808, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What build to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2809, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the builds in descending order based on their start date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2810, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2811, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "BuildShort", + "target": "333" + } + ] + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3978, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the Actor build collection.\n\nProvides methods to manage Actor builds, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2796, + 2806, + 2800 + ], + "title": "Methods" + }, + { + "children": [ + 3978 + ], + "title": "Properties" + } + ], + "id": 2795, + "module": "_resource_clients.build_collection", + "name": "BuildCollectionClientAsync", + "parsedDocstring": { + "text": "Sub-client for the Actor build collection.\n\nProvides methods to manage Actor builds, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 97 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of dataset items. Each item is a JSON object (dictionary)." + } + ] + }, + "flags": {}, + "groups": [], + "id": 2813, + "module": "_resource_clients.dataset", + "name": "items", + "parsedDocstring": { + "text": "List of dataset items. Each item is a JSON object (dictionary)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 37 + } + ], + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Total number of items in the dataset." + } + ] + }, + "flags": {}, + "groups": [], + "id": 2814, + "module": "_resource_clients.dataset", + "name": "total", + "parsedDocstring": { + "text": "Total number of items in the dataset." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 40 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The offset of the first item in this page." + } + ] + }, + "flags": {}, + "groups": [], + "id": 2815, + "module": "_resource_clients.dataset", + "name": "offset", + "parsedDocstring": { + "text": "The offset of the first item in this page." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 43 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of items in this page." + } + ] + }, + "flags": {}, + "groups": [], + "id": 2816, + "module": "_resource_clients.dataset", + "name": "count", + "parsedDocstring": { + "text": "Number of items in this page." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 46 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The limit that was used for this request." + } + ] + }, + "flags": {}, + "groups": [], + "id": 2817, + "module": "_resource_clients.dataset", + "name": "limit", + "parsedDocstring": { + "text": "The limit that was used for this request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 49 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the items are sorted in descending order." + } + ] + }, + "flags": {}, + "groups": [], + "id": 2818, + "module": "_resource_clients.dataset", + "name": "desc", + "parsedDocstring": { + "text": "Whether the items are sorted in descending order." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 52 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A page of dataset items returned by the `list_items` method.\n\nDataset items are arbitrary JSON objects stored in the dataset, so they cannot be\nrepresented by a specific Pydantic model. This class provides pagination metadata\nalong with the raw items." + } + ] + }, + "decorations": [ + { + "args": "('Other')", + "name": "docs_group" + }, + { + "name": "dataclass" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2816, + 2818, + 2813, + 2817, + 2815, + 2814 + ], + "title": "Properties" + } + ], + "id": 2812, + "module": "_resource_clients.dataset", + "name": "DatasetItemsPage", + "parsedDocstring": { + "text": "A page of dataset items returned by the `list_items` method.\n\nDataset items are arbitrary JSON objects stored in the dataset, so they cannot be\nrepresented by a specific Pydantic model. This class provides pagination metadata\nalong with the raw items." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 29 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2820, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 64 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2825, + "module": "_resource_clients.dataset", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved dataset, or None, if it does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 77 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved dataset, or None, if it does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n" + } + ] + }, + "flags": {}, + "id": 2826, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2827, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Dataset | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Dataset", + "target": "432" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2828, + "module": "_resource_clients.dataset", + "name": "update", + "parsedDocstring": { + "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n", + "args": { + "name": "The new name for the dataset.", + "general_access": "Determines how others can access the dataset.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated dataset." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 93 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated dataset." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n" + } + ] + }, + "flags": {}, + "id": 2829, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new name for the dataset." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2830, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Determines how others can access the dataset." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2831, + "kind": 32768, + "kindString": "Parameter", + "name": "general_access", + "type": { + "name": "GeneralAccess | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "GeneralAccess", + "target": "1797" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2832, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Dataset", + "type": "reference", + "target": "432" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2833, + "module": "_resource_clients.dataset", + "name": "delete", + "parsedDocstring": { + "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 119 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset\n" + } + ] + }, + "flags": {}, + "id": 2834, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2835, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2836, + "module": "_resource_clients.dataset", + "name": "list_items", + "parsedDocstring": { + "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n", + "args": { + "offset": "Number of items that should be skipped at the start. The default value is 0.", + "limit": "Maximum number of items to return. By default there is no limit.", + "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", + "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.", + "fields": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.", + "omit": "A list of fields which should be omitted from the items.", + "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.", + "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.", + "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.", + "flatten": "A list of fields that should be flattened.", + "view": "Name of the dataset view to be used.", + "signature": "Signature used to access the items.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "A page of the list of dataset items according to the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 129 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A page of the list of dataset items according to the specified filters." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "flags": {}, + "id": 2837, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list_items", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of items that should be skipped at the start. The default value is 0." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2838, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of items to return. By default there is no limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2839, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2840, + "kind": 32768, + "kindString": "Parameter", + "name": "clean", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2841, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2842, + "kind": 32768, + "kindString": "Parameter", + "name": "fields", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be omitted from the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2843, + "kind": 32768, + "kindString": "Parameter", + "name": "omit", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2844, + "kind": 32768, + "kindString": "Parameter", + "name": "unwind", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2845, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_empty", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2846, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_hidden", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields that should be flattened." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2847, + "kind": 32768, + "kindString": "Parameter", + "name": "flatten", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the dataset view to be used." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2848, + "kind": 32768, + "kindString": "Parameter", + "name": "view", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signature used to access the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2849, + "kind": 32768, + "kindString": "Parameter", + "name": "signature", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2850, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "DatasetItemsPage", + "type": "reference", + "target": "2812" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the items in the dataset.\n\nSimple `list_items` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2851, + "module": "_resource_clients.dataset", + "name": "iterate_items", + "parsedDocstring": { + "text": "Iterate over the items in the dataset.\n\nSimple `list_items` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n", + "args": { + "offset": "Number of items that should be skipped at the start. The default value is 0.", + "limit": "Maximum number of items to return. By default there is no limit.", + "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", + "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.", + "fields": "A list of fields which should be picked from the items, only these fields will remain in\nthe resulting record objects. Note that the fields in the outputted items are sorted the same way\nas they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.", + "omit": "A list of fields which should be omitted from the items.", + "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.", + "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.", + "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.", + "signature": "Signature used to access the items.", + "chunk_size": "Maximum number of items requested per API call when iterating across pages.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 219 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the items in the dataset.\n\nSimple `list_items` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "flags": {}, + "id": 2852, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate_items", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of items that should be skipped at the start. The default value is 0." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2853, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of items to return. By default there is no limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2854, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2855, + "kind": 32768, + "kindString": "Parameter", + "name": "clean", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2856, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be picked from the items, only these fields will remain in\nthe resulting record objects. Note that the fields in the outputted items are sorted the same way\nas they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2857, + "kind": 32768, + "kindString": "Parameter", + "name": "fields", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be omitted from the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2858, + "kind": 32768, + "kindString": "Parameter", + "name": "omit", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2859, + "kind": 32768, + "kindString": "Parameter", + "name": "unwind", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2860, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_empty", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2861, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_hidden", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signature used to access the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2862, + "kind": 32768, + "kindString": "Parameter", + "name": "signature", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of items requested per API call when iterating across pages." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2863, + "kind": 32768, + "kindString": "Parameter", + "name": "chunk_size", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2864, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "dict" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2865, + "module": "_resource_clients.dataset", + "name": "get_items_as_bytes", + "parsedDocstring": { + "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n", + "args": { + "item_format": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json.", + "offset": "Number of items that should be skipped at the start. The default value is 0.", + "limit": "Maximum number of items to return. By default there is no limit.", + "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", + "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.", + "bom": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it.", + "delimiter": "A delimiter character for CSV files. The default delimiter is a simple comma (,).", + "fields": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format.", + "omit": "A list of fields which should be omitted from the items.", + "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.", + "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.", + "skip_header_row": "If True, then header row in the csv format is skipped.", + "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.", + "xml_root": "Overrides default root element name of xml output. By default the root element is items.", + "xml_row": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item.", + "flatten": "A list of fields that should be flattened.", + "signature": "Signature used to access the items.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The dataset items as raw bytes." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 291 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The dataset items as raw bytes." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "flags": {}, + "id": 2866, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_items_as_bytes", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json." + } + ] + }, + "defaultValue": "'json'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2867, + "kind": 32768, + "kindString": "Parameter", + "name": "item_format", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of items that should be skipped at the start. The default value is 0." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2868, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of items to return. By default there is no limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2869, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2870, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2871, + "kind": 32768, + "kindString": "Parameter", + "name": "clean", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2872, + "kind": 32768, + "kindString": "Parameter", + "name": "bom", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A delimiter character for CSV files. The default delimiter is a simple comma (,)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2873, + "kind": 32768, + "kindString": "Parameter", + "name": "delimiter", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2874, + "kind": 32768, + "kindString": "Parameter", + "name": "fields", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be omitted from the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2875, + "kind": 32768, + "kindString": "Parameter", + "name": "omit", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2876, + "kind": 32768, + "kindString": "Parameter", + "name": "unwind", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2877, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_empty", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then header row in the csv format is skipped." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2878, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_header_row", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2879, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_hidden", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Overrides default root element name of xml output. By default the root element is items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2880, + "kind": 32768, + "kindString": "Parameter", + "name": "xml_root", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2881, + "kind": 32768, + "kindString": "Parameter", + "name": "xml_row", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields that should be flattened." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2882, + "kind": 32768, + "kindString": "Parameter", + "name": "flatten", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signature used to access the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2883, + "kind": 32768, + "kindString": "Parameter", + "name": "signature", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2884, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "bytes", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "decorations": [ + { + "name": "contextmanager" + } + ], + "flags": {}, + "groups": [], + "id": 2885, + "module": "_resource_clients.dataset", + "name": "stream_items", + "parsedDocstring": { + "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n", + "args": { + "item_format": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json.", + "offset": "Number of items that should be skipped at the start. The default value is 0.", + "limit": "Maximum number of items to return. By default there is no limit.", + "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", + "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.", + "bom": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it.", + "delimiter": "A delimiter character for CSV files. The default delimiter is a simple comma (,).", + "fields": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format.", + "omit": "A list of fields which should be omitted from the items.", + "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.", + "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.", + "skip_header_row": "If True, then header row in the csv format is skipped.", + "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.", + "xml_root": "Overrides default root element name of xml output. By default the root element is items.", + "xml_row": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item.", + "signature": "Signature used to access the items.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The dataset items as a context-managed streaming `Response`." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 390 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The dataset items as a context-managed streaming `Response`." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "flags": {}, + "id": 2886, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "stream_items", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json." + } + ] + }, + "defaultValue": "'json'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2887, + "kind": 32768, + "kindString": "Parameter", + "name": "item_format", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of items that should be skipped at the start. The default value is 0." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2888, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of items to return. By default there is no limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2889, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2890, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2891, + "kind": 32768, + "kindString": "Parameter", + "name": "clean", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2892, + "kind": 32768, + "kindString": "Parameter", + "name": "bom", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A delimiter character for CSV files. The default delimiter is a simple comma (,)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2893, + "kind": 32768, + "kindString": "Parameter", + "name": "delimiter", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2894, + "kind": 32768, + "kindString": "Parameter", + "name": "fields", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be omitted from the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2895, + "kind": 32768, + "kindString": "Parameter", + "name": "omit", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2896, + "kind": 32768, + "kindString": "Parameter", + "name": "unwind", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2897, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_empty", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then header row in the csv format is skipped." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2898, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_header_row", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2899, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_hidden", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Overrides default root element name of xml output. By default the root element is items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2900, + "kind": 32768, + "kindString": "Parameter", + "name": "xml_root", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2901, + "kind": 32768, + "kindString": "Parameter", + "name": "xml_row", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signature used to access the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2902, + "kind": 32768, + "kindString": "Parameter", + "name": "signature", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2903, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "HttpResponse", + "target": "1805" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2904, + "module": "_resource_clients.dataset", + "name": "push_items", + "parsedDocstring": { + "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n", + "args": { + "items": "The items which to push in the dataset. Either a stringified JSON, a dictionary, or a list\nof strings or dictionaries.", + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 490 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n" + } + ] + }, + "flags": {}, + "id": 2905, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "push_items", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The items which to push in the dataset. Either a stringified JSON, a dictionary, or a list\nof strings or dictionaries." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 2906, + "kind": 32768, + "kindString": "Parameter", + "name": "items", + "type": { + "name": "JsonSerializable", + "type": "reference", + "target": "15" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2907, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2908, + "module": "_resource_clients.dataset", + "name": "get_statistics", + "parsedDocstring": { + "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The dataset statistics." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 518 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The dataset statistics." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n" + } + ] + }, + "flags": {}, + "id": 2909, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_statistics", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2910, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "DatasetStatistics", + "type": "reference", + "target": "477" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2911, + "module": "_resource_clients.dataset", + "name": "create_items_public_url", + "parsedDocstring": { + "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n", + "args": { + "offset": "Number of items that should be skipped at the start. The default value is 0.", + "limit": "Maximum number of items to return. By default there is no limit.", + "clean": "If True, returns only non-empty items and skips hidden fields.", + "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", + "fields": "A list of fields which should be picked from the items.", + "omit": "A list of fields which should be omitted from the items.", + "unwind": "A list of fields which should be unwound, in order which they should be processed.", + "skip_empty": "If True, then empty items are skipped from the output.", + "skip_hidden": "If True, then hidden fields are skipped from the output.", + "flatten": "A list of fields that should be flattened.", + "view": "Name of the dataset view to be used.", + "expires_in": "How long the signed URL should be valid.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The public dataset items URL." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 541 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The public dataset items URL." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n" + } + ] + }, + "flags": {}, + "id": 2912, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "create_items_public_url", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of items that should be skipped at the start. The default value is 0." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2913, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of items to return. By default there is no limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2914, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, returns only non-empty items and skips hidden fields." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2915, + "kind": 32768, + "kindString": "Parameter", + "name": "clean", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2916, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be picked from the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2917, + "kind": 32768, + "kindString": "Parameter", + "name": "fields", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be omitted from the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2918, + "kind": 32768, + "kindString": "Parameter", + "name": "omit", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be unwound, in order which they should be processed." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2919, + "kind": 32768, + "kindString": "Parameter", + "name": "unwind", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then empty items are skipped from the output." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2920, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_empty", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then hidden fields are skipped from the output." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2921, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_hidden", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields that should be flattened." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2922, + "kind": 32768, + "kindString": "Parameter", + "name": "flatten", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the dataset view to be used." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2923, + "kind": 32768, + "kindString": "Parameter", + "name": "view", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How long the signed URL should be valid." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2924, + "kind": 32768, + "kindString": "Parameter", + "name": "expires_in", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2925, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 4006, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific dataset.\n\nProvides methods to manage a specific dataset, e.g. get it, update it, or download its items. Obtain an instance\nvia an appropriate method on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2820, + 2911, + 2833, + 2825, + 2865, + 2908, + 2851, + 2836, + 2904, + 2885, + 2828 + ], + "title": "Methods" + }, + { + "children": [ + 4006 + ], + "title": "Properties" + } + ], + "id": 2819, + "module": "_resource_clients.dataset", + "name": "DatasetClient", + "parsedDocstring": { + "text": "Sub-client for managing a specific dataset.\n\nProvides methods to manage a specific dataset, e.g. get it, update it, or download its items. Obtain an instance\nvia an appropriate method on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 57 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2927, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 628 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2932, + "module": "_resource_clients.dataset", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved dataset, or None, if it does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 641 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved dataset, or None, if it does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n" + } + ] + }, + "flags": {}, + "id": 2933, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2934, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Dataset | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Dataset", + "target": "432" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2935, + "module": "_resource_clients.dataset", + "name": "update", + "parsedDocstring": { + "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n", + "args": { + "name": "The new name for the dataset.", + "general_access": "Determines how others can access the dataset.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated dataset." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 657 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated dataset." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the dataset with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/update-dataset\n" + } + ] + }, + "flags": {}, + "id": 2936, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new name for the dataset." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2937, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Determines how others can access the dataset." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2938, + "kind": 32768, + "kindString": "Parameter", + "name": "general_access", + "type": { + "name": "GeneralAccess | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "GeneralAccess", + "target": "1797" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2939, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Dataset", + "type": "reference", + "target": "432" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2940, + "module": "_resource_clients.dataset", + "name": "delete", + "parsedDocstring": { + "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 683 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset\n" + } + ] + }, + "flags": {}, + "id": 2941, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2942, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2943, + "module": "_resource_clients.dataset", + "name": "list_items", + "parsedDocstring": { + "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n", + "args": { + "offset": "Number of items that should be skipped at the start. The default value is 0.", + "limit": "Maximum number of items to return. By default there is no limit.", + "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", + "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.", + "fields": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.", + "omit": "A list of fields which should be omitted from the items.", + "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.", + "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.", + "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.", + "flatten": "A list of fields that should be flattened.", + "view": "Name of the dataset view to be used.", + "signature": "Signature used to access the items.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "A page of the list of dataset items according to the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 693 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A page of the list of dataset items according to the specified filters." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the items of the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "flags": {}, + "id": 2944, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "list_items", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of items that should be skipped at the start. The default value is 0." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2945, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of items to return. By default there is no limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2946, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2947, + "kind": 32768, + "kindString": "Parameter", + "name": "clean", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2948, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2949, + "kind": 32768, + "kindString": "Parameter", + "name": "fields", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be omitted from the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2950, + "kind": 32768, + "kindString": "Parameter", + "name": "omit", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2951, + "kind": 32768, + "kindString": "Parameter", + "name": "unwind", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2952, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_empty", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2953, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_hidden", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields that should be flattened." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2954, + "kind": 32768, + "kindString": "Parameter", + "name": "flatten", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the dataset view to be used." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2955, + "kind": 32768, + "kindString": "Parameter", + "name": "view", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signature used to access the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2956, + "kind": 32768, + "kindString": "Parameter", + "name": "signature", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2957, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "DatasetItemsPage", + "type": "reference", + "target": "2812" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the items in the dataset.\n\nSimple `list_items` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2958, + "module": "_resource_clients.dataset", + "name": "iterate_items", + "parsedDocstring": { + "text": "Iterate over the items in the dataset.\n\nSimple `list_items` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n", + "args": { + "offset": "Number of items that should be skipped at the start. The default value is 0.", + "limit": "Maximum number of items to return. By default there is no limit.", + "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", + "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.", + "fields": "A list of fields which should be picked from the items, only these fields will remain in\nthe resulting record objects. Note that the fields in the outputted items are sorted the same way\nas they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.", + "omit": "A list of fields which should be omitted from the items.", + "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.", + "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.", + "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.", + "signature": "Signature used to access the items.", + "chunk_size": "Maximum number of items requested per API call when iterating across pages.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 783 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the items in the dataset.\n\nSimple `list_items` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "flags": {}, + "id": 2959, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate_items", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of items that should be skipped at the start. The default value is 0." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2960, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of items to return. By default there is no limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2961, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2962, + "kind": 32768, + "kindString": "Parameter", + "name": "clean", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2963, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be picked from the items, only these fields will remain in\nthe resulting record objects. Note that the fields in the outputted items are sorted the same way\nas they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2964, + "kind": 32768, + "kindString": "Parameter", + "name": "fields", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be omitted from the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2965, + "kind": 32768, + "kindString": "Parameter", + "name": "omit", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2966, + "kind": 32768, + "kindString": "Parameter", + "name": "unwind", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2967, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_empty", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2968, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_hidden", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signature used to access the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2969, + "kind": 32768, + "kindString": "Parameter", + "name": "signature", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of items requested per API call when iterating across pages." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2970, + "kind": 32768, + "kindString": "Parameter", + "name": "chunk_size", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2971, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "dict" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 2972, + "module": "_resource_clients.dataset", + "name": "get_items_as_bytes", + "parsedDocstring": { + "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n", + "args": { + "item_format": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json.", + "offset": "Number of items that should be skipped at the start. The default value is 0.", + "limit": "Maximum number of items to return. By default there is no limit.", + "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", + "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.", + "bom": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it.", + "delimiter": "A delimiter character for CSV files. The default delimiter is a simple comma (,).", + "fields": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format.", + "omit": "A list of fields which should be omitted from the items.", + "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.", + "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.", + "skip_header_row": "If True, then header row in the csv format is skipped.", + "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.", + "xml_root": "Overrides default root element name of xml output. By default the root element is items.", + "xml_row": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item.", + "flatten": "A list of fields that should be flattened.", + "signature": "Signature used to access the items.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The dataset items as raw bytes." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 857 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The dataset items as raw bytes." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "flags": {}, + "id": 2973, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_items_as_bytes", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json." + } + ] + }, + "defaultValue": "'json'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2974, + "kind": 32768, + "kindString": "Parameter", + "name": "item_format", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of items that should be skipped at the start. The default value is 0." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2975, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of items to return. By default there is no limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2976, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2977, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2978, + "kind": 32768, + "kindString": "Parameter", + "name": "clean", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2979, + "kind": 32768, + "kindString": "Parameter", + "name": "bom", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A delimiter character for CSV files. The default delimiter is a simple comma (,)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2980, + "kind": 32768, + "kindString": "Parameter", + "name": "delimiter", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2981, + "kind": 32768, + "kindString": "Parameter", + "name": "fields", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be omitted from the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2982, + "kind": 32768, + "kindString": "Parameter", + "name": "omit", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2983, + "kind": 32768, + "kindString": "Parameter", + "name": "unwind", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2984, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_empty", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then header row in the csv format is skipped." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2985, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_header_row", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2986, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_hidden", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Overrides default root element name of xml output. By default the root element is items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2987, + "kind": 32768, + "kindString": "Parameter", + "name": "xml_root", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2988, + "kind": 32768, + "kindString": "Parameter", + "name": "xml_row", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields that should be flattened." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2989, + "kind": 32768, + "kindString": "Parameter", + "name": "flatten", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signature used to access the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2990, + "kind": 32768, + "kindString": "Parameter", + "name": "signature", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2991, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "bytes", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "decorations": [ + { + "name": "asynccontextmanager" + } + ], + "flags": {}, + "groups": [], + "id": 2992, + "module": "_resource_clients.dataset", + "name": "stream_items", + "parsedDocstring": { + "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n", + "args": { + "item_format": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json.", + "offset": "Number of items that should be skipped at the start. The default value is 0.", + "limit": "Maximum number of items to return. By default there is no limit.", + "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", + "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value.", + "bom": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it.", + "delimiter": "A delimiter character for CSV files. The default delimiter is a simple comma (,).", + "fields": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format.", + "omit": "A list of fields which should be omitted from the items.", + "unwind": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter.", + "skip_empty": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value.", + "skip_header_row": "If True, then header row in the csv format is skipped.", + "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character.", + "xml_root": "Overrides default root element name of xml output. By default the root element is items.", + "xml_row": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item.", + "signature": "Signature used to access the items.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The dataset items as a context-managed streaming `Response`." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 956 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The dataset items as a context-managed streaming `Response`." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the items in the dataset as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "flags": {}, + "id": 2993, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "stream_items", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss.\nThe default value is json." + } + ] + }, + "defaultValue": "'json'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2994, + "kind": 32768, + "kindString": "Parameter", + "name": "item_format", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of items that should be skipped at the start. The default value is 0." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2995, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of items to return. By default there is no limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2996, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2997, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with\nthe # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True\nparameters. Note that since some objects might be skipped from the output, that the result might\ncontain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2998, + "kind": 32768, + "kindString": "Parameter", + "name": "clean", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with\nthe UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want\nto override this default behavior, specify bom=True query parameter to include the BOM or bom=False\nto skip it." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 2999, + "kind": 32768, + "kindString": "Parameter", + "name": "bom", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A delimiter character for CSV files. The default delimiter is a simple comma (,)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3000, + "kind": 32768, + "kindString": "Parameter", + "name": "delimiter", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be picked from the items, only these fields will remain\nin the resulting record objects. Note that the fields in the outputted items are sorted the same\nway as they are specified in the fields parameter. You can use this feature to effectively fix\nthe output format.\nYou can use this feature to effectively fix the output format." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3001, + "kind": 32768, + "kindString": "Parameter", + "name": "fields", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be omitted from the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3002, + "kind": 32768, + "kindString": "Parameter", + "name": "omit", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be unwound, in order which they should be processed. Each field\nshould be either an array or an object. If the field is an array then every element of the array\nwill become a separate record and merged with parent object. If the unwound field is an object then\nit is merged with the parent object. If the unwound field is missing or its value is neither an array\nnor an object and therefore cannot be merged with a parent object, then the item gets preserved\nas it is. Note that the unwound items ignore the desc parameter." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3003, + "kind": 32768, + "kindString": "Parameter", + "name": "unwind", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then empty items are skipped from the output. Note that if used, the results might\ncontain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3004, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_empty", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then header row in the csv format is skipped." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3005, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_header_row", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with\nthe # character." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3006, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_hidden", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Overrides default root element name of xml output. By default the root element is items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3007, + "kind": 32768, + "kindString": "Parameter", + "name": "xml_root", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Overrides default element name that wraps each page or page function result object in xml output.\nBy default the element name is item." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3008, + "kind": 32768, + "kindString": "Parameter", + "name": "xml_row", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signature used to access the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3009, + "kind": 32768, + "kindString": "Parameter", + "name": "signature", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3010, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "HttpResponse", + "target": "1805" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3011, + "module": "_resource_clients.dataset", + "name": "push_items", + "parsedDocstring": { + "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n", + "args": { + "items": "The items which to push in the dataset. Either a stringified JSON, a dictionary, or a list\nof strings or dictionaries.", + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1056 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Push items to the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/put-items\n" + } + ] + }, + "flags": {}, + "id": 3012, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "push_items", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The items which to push in the dataset. Either a stringified JSON, a dictionary, or a list\nof strings or dictionaries." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3013, + "kind": 32768, + "kindString": "Parameter", + "name": "items", + "type": { + "name": "JsonSerializable", + "type": "reference", + "target": "15" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3014, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3015, + "module": "_resource_clients.dataset", + "name": "get_statistics", + "parsedDocstring": { + "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The dataset statistics." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1084 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The dataset statistics." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get the dataset statistics.\n\nhttps://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get\n" + } + ] + }, + "flags": {}, + "id": 3016, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_statistics", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3017, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "DatasetStatistics", + "type": "reference", + "target": "477" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3018, + "module": "_resource_clients.dataset", + "name": "create_items_public_url", + "parsedDocstring": { + "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n", + "args": { + "offset": "Number of items that should be skipped at the start. The default value is 0.", + "limit": "Maximum number of items to return. By default there is no limit.", + "clean": "If True, returns only non-empty items and skips hidden fields.", + "desc": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True.", + "fields": "A list of fields which should be picked from the items.", + "omit": "A list of fields which should be omitted from the items.", + "unwind": "A list of fields which should be unwound, in order which they should be processed.", + "skip_empty": "If True, then empty items are skipped from the output.", + "skip_hidden": "If True, then hidden fields are skipped from the output.", + "flatten": "A list of fields that should be flattened.", + "view": "Name of the dataset view to be used.", + "expires_in": "How long the signed URL should be valid.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The public dataset items URL." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1107 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The public dataset items URL." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `offset`) will be included as query parameters in the URL.\n" + } + ] + }, + "flags": {}, + "id": 3019, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "create_items_public_url", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of items that should be skipped at the start. The default value is 0." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3020, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of items to return. By default there is no limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3021, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, returns only non-empty items and skips hidden fields." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3022, + "kind": 32768, + "kindString": "Parameter", + "name": "clean", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "By default, results are returned in the same order as they were stored. To reverse the order,\nset this parameter to True." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3023, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be picked from the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3024, + "kind": 32768, + "kindString": "Parameter", + "name": "fields", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be omitted from the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3025, + "kind": 32768, + "kindString": "Parameter", + "name": "omit", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be unwound, in order which they should be processed." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3026, + "kind": 32768, + "kindString": "Parameter", + "name": "unwind", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then empty items are skipped from the output." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3027, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_empty", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then hidden fields are skipped from the output." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3028, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_hidden", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields that should be flattened." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3029, + "kind": 32768, + "kindString": "Parameter", + "name": "flatten", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the dataset view to be used." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3030, + "kind": 32768, + "kindString": "Parameter", + "name": "view", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How long the signed URL should be valid." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3031, + "kind": 32768, + "kindString": "Parameter", + "name": "expires_in", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3032, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3979, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific dataset.\n\nProvides methods to manage a specific dataset, e.g. get it, update it, or download its items. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 2927, + 3018, + 2940, + 2932, + 2972, + 3015, + 2958, + 2943, + 3011, + 2992, + 2935 + ], + "title": "Methods" + }, + { + "children": [ + 3979 + ], + "title": "Properties" + } + ], + "id": 2926, + "module": "_resource_clients.dataset", + "name": "DatasetClientAsync", + "parsedDocstring": { + "text": "Sub-client for managing a specific dataset.\n\nProvides methods to manage a specific dataset, e.g. get it, update it, or download its items. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 621 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3034, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 44 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3039, + "module": "_resource_clients.run", + "name": "get", + "parsedDocstring": { + "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved Actor run data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 57 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved Actor run data." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n" + } + ] + }, + "flags": {}, + "id": 3040, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3041, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Run", + "target": "958" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3042, + "module": "_resource_clients.run", + "name": "update", + "parsedDocstring": { + "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n", + "args": { + "status_message": "The new status message for the run.", + "is_status_message_terminal": "Set this flag to True if this is the final status message of the Actor run.", + "general_access": "Determines how others can access the run and its storages.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 73 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated run." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n" + } + ] + }, + "flags": {}, + "id": 3043, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new status message for the run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3044, + "kind": 32768, + "kindString": "Parameter", + "name": "status_message", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set this flag to True if this is the final status message of the Actor run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3045, + "kind": 32768, + "kindString": "Parameter", + "name": "is_status_message_terminal", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Determines how others can access the run and its storages." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3046, + "kind": 32768, + "kindString": "Parameter", + "name": "general_access", + "type": { + "name": "GeneralAccess | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "GeneralAccess", + "target": "1797" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3047, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run", + "type": "reference", + "target": "958" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3048, + "module": "_resource_clients.run", + "name": "delete", + "parsedDocstring": { + "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 102 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run\n" + } + ] + }, + "flags": {}, + "id": 3049, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3050, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3051, + "module": "_resource_clients.run", + "name": "abort", + "parsedDocstring": { + "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n", + "args": { + "gracefully": "If True, the Actor run will abort gracefully. It will send `aborting` and `persistStates`\nevents into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\nto resurrect the run later.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The data of the aborted Actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 112 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The data of the aborted Actor run." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n" + } + ] + }, + "flags": {}, + "id": 3052, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "abort", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, the Actor run will abort gracefully. It will send `aborting` and `persistStates`\nevents into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\nto resurrect the run later." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3053, + "kind": 32768, + "kindString": "Parameter", + "name": "gracefully", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3054, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run", + "type": "reference", + "target": "958" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wait synchronously until the run finishes or the server times out.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3055, + "module": "_resource_clients.run", + "name": "wait_for_finish", + "parsedDocstring": { + "text": "Wait synchronously until the run finishes or the server times out.\n", + "args": { + "wait_duration": "How long does the client wait for run to finish. None for indefinite.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The Actor run data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the run has not yet finished." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 135 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The Actor run data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the run has not yet finished." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Wait synchronously until the run finishes or the server times out.\n" + } + ] + }, + "flags": {}, + "id": 3056, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "wait_for_finish", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How long does the client wait for run to finish. None for indefinite." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3057, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_duration", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'no_timeout'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3058, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Run", + "target": "958" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3059, + "module": "_resource_clients.run", + "name": "metamorph", + "parsedDocstring": { + "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n", + "args": { + "target_actor_id": "ID of the target Actor that the run should be transformed into.", + "target_actor_build": "The build of the target Actor. It can be either a build tag or build number.\nBy default, the run uses the build specified in the default run configuration for the target Actor\n(typically the latest build).", + "run_input": "The input to pass to the new run.", + "content_type": "The content type of the input.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The Actor run data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 163 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The Actor run data." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n" + } + ] + }, + "flags": {}, + "id": 3060, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "metamorph", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the target Actor that the run should be transformed into." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3061, + "kind": 32768, + "kindString": "Parameter", + "name": "target_actor_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The build of the target Actor. It can be either a build tag or build number.\nBy default, the run uses the build specified in the default run configuration for the target Actor\n(typically the latest build)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3062, + "kind": 32768, + "kindString": "Parameter", + "name": "target_actor_build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The input to pass to the new run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3063, + "kind": 32768, + "kindString": "Parameter", + "name": "run_input", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the input." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3064, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3065, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run", + "type": "reference", + "target": "958" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3066, + "module": "_resource_clients.run", + "name": "resurrect", + "parsedDocstring": { + "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n", + "args": { + "build": "Which Actor build the resurrected run should use. It can be either a build tag or build number.\nBy default, the resurrected run uses the same build as before.", + "memory_mbytes": "New memory limit for the resurrected run, in megabytes. By default, the resurrected run\nuses the same memory limit as before.", + "run_timeout": "New timeout for the resurrected run. By default, the resurrected run uses the\nsame timeout as before.", + "max_items": "Maximum number of items that the resurrected pay-per-result run will return. By default, the\nresurrected run uses the same limit as before. Limit can be only increased.", + "max_total_charge_usd": "Maximum cost for the resurrected pay-per-event run in USD. By default, the\nresurrected run uses the same limit as before. Limit can be only increased.", + "restart_on_error": "Determines whether the resurrected run will be restarted if it fails.\nBy default, the resurrected run uses the same setting as before.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The Actor run data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 206 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The Actor run data." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n" + } + ] + }, + "flags": {}, + "id": 3067, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "resurrect", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Which Actor build the resurrected run should use. It can be either a build tag or build number.\nBy default, the resurrected run uses the same build as before." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3068, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "New memory limit for the resurrected run, in megabytes. By default, the resurrected run\nuses the same memory limit as before." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3069, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "New timeout for the resurrected run. By default, the resurrected run uses the\nsame timeout as before." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3070, + "kind": 32768, + "kindString": "Parameter", + "name": "run_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of items that the resurrected pay-per-result run will return. By default, the\nresurrected run uses the same limit as before. Limit can be only increased." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3071, + "kind": 32768, + "kindString": "Parameter", + "name": "max_items", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum cost for the resurrected pay-per-event run in USD. By default, the\nresurrected run uses the same limit as before. Limit can be only increased." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3072, + "kind": 32768, + "kindString": "Parameter", + "name": "max_total_charge_usd", + "type": { + "name": "Decimal | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Decimal" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Determines whether the resurrected run will be restarted if it fails.\nBy default, the resurrected run uses the same setting as before." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3073, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3074, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run", + "type": "reference", + "target": "958" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3075, + "module": "_resource_clients.run", + "name": "reboot", + "parsedDocstring": { + "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The Actor run data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 261 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The Actor run data." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n" + } + ] + }, + "flags": {}, + "id": 3076, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "reboot", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3077, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run", + "type": "reference", + "target": "958" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3078, + "module": "_resource_clients.run", + "name": "dataset", + "parsedDocstring": { + "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n", + "returns": "A client allowing access to the default dataset of this Actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 280 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A client allowing access to the default dataset of this Actor run." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" + } + ] + }, + "flags": {}, + "id": 3079, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "dataset", + "parameters": [], + "type": { + "name": "DatasetClient", + "type": "reference", + "target": "2819" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3080, + "module": "_resource_clients.run", + "name": "key_value_store", + "parsedDocstring": { + "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n", + "returns": "A client allowing access to the default key-value store of this Actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 293 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A client allowing access to the default key-value store of this Actor run." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" + } + ] + }, + "flags": {}, + "id": 3081, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "key_value_store", + "parameters": [], + "type": { + "name": "KeyValueStoreClient", + "type": "reference", + "target": "3608" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3082, + "module": "_resource_clients.run", + "name": "request_queue", + "parsedDocstring": { + "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n", + "returns": "A client allowing access to the default request_queue of this Actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 306 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A client allowing access to the default request_queue of this Actor run." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" + } + ] + }, + "flags": {}, + "id": 3083, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "request_queue", + "parameters": [], + "type": { + "name": "RequestQueueClient", + "type": "reference", + "target": "1996" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3084, + "module": "_resource_clients.run", + "name": "log", + "parsedDocstring": { + "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n", + "returns": "A client allowing access to the log of this Actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 319 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A client allowing access to the log of this Actor run." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" + } + ] + }, + "flags": {}, + "id": 3085, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "log", + "parameters": [], + "type": { + "name": "LogClient", + "type": "reference", + "target": "2160" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n`StreamedLog` can be explicitly started and stopped or used as a context manager.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3086, + "module": "_resource_clients.run", + "name": "get_streamed_log", + "parsedDocstring": { + "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n`StreamedLog` can be explicitly started and stopped or used as a context manager.\n", + "args": { + "to_logger": "`Logger` used for logging the redirected messages. If not provided, a new logger is created", + "from_start": "If `True`, all logs from the start of the Actor run will be redirected. If `False`, only newly\narrived logs will be redirected. This can be useful for redirecting only a small portion of relevant\nlogs for long-running Actors in stand-by.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "`StreamedLog` instance for redirected logs." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 332 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "`StreamedLog` instance for redirected logs." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n`StreamedLog` can be explicitly started and stopped or used as a context manager.\n" + } + ] + }, + "flags": {}, + "id": 3087, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_streamed_log", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "`Logger` used for logging the redirected messages. If not provided, a new logger is created" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 3088, + "kind": 32768, + "kindString": "Parameter", + "name": "to_logger", + "type": { + "name": "logging.Logger | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "logging.Logger" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If `True`, all logs from the start of the Actor run will be redirected. If `False`, only newly\narrived logs will be redirected. This can be useful for redirecting only a small portion of relevant\nlogs for long-running Actors in stand-by." + } + ] + }, + "defaultValue": "True", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3089, + "kind": 32768, + "kindString": "Parameter", + "name": "from_start", + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3090, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "StreamedLog", + "type": "reference", + "target": "44" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3091, + "module": "_resource_clients.run", + "name": "charge", + "parsedDocstring": { + "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n", + "args": { + "event_name": "The name of the event to charge for.", + "count": "The number of events to charge.", + "idempotency_key": "A unique key to ensure idempotent charging. If not provided,\none will be auto-generated.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 375 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n" + } + ] + }, + "flags": {}, + "id": 3092, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "charge", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the event to charge for." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3093, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of events to charge." + } + ] + }, + "defaultValue": "1", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3094, + "kind": 32768, + "kindString": "Parameter", + "name": "count", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key to ensure idempotent charging. If not provided,\none will be auto-generated." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3095, + "kind": 32768, + "kindString": "Parameter", + "name": "idempotency_key", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3096, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3097, + "module": "_resource_clients.run", + "name": "get_status_message_watcher", + "parsedDocstring": { + "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n", + "args": { + "to_logger": "`Logger` used for logging the status and status messages. If not provided, a new logger is\ncreated.", + "check_period": "The period with which the status message will be polled.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "`StatusMessageWatcher` instance." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 421 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "`StatusMessageWatcher` instance." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n" + } + ] + }, + "flags": {}, + "id": 3098, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_status_message_watcher", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "`Logger` used for logging the status and status messages. If not provided, a new logger is\ncreated." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3099, + "kind": 32768, + "kindString": "Parameter", + "name": "to_logger", + "type": { + "name": "logging.Logger | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "logging.Logger" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The period with which the status message will be polled." + } + ] + }, + "defaultValue": "timedelta(seconds=1)", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3100, + "kind": 32768, + "kindString": "Parameter", + "name": "check_period", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3101, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "StatusMessageWatcher", + "type": "reference", + "target": "1693" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 4007, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific Actor run.\n\nProvides methods to manage a specific Actor run, e.g. get it, update it, abort it, or wait for it to finish.\nObtain an instance via an appropriate method on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3034, + 3051, + 3091, + 3078, + 3048, + 3039, + 3097, + 3086, + 3080, + 3084, + 3059, + 3075, + 3082, + 3066, + 3042, + 3055 + ], + "title": "Methods" + }, + { + "children": [ + 4007 + ], + "title": "Properties" + } + ], + "id": 3033, + "module": "_resource_clients.run", + "name": "RunClient", + "parsedDocstring": { + "text": "Sub-client for managing a specific Actor run.\n\nProvides methods to manage a specific Actor run, e.g. get it, update it, abort it, or wait for it to finish.\nObtain an instance via an appropriate method on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 37 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3103, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 472 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3108, + "module": "_resource_clients.run", + "name": "get", + "parsedDocstring": { + "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved Actor run data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 485 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved Actor run data." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run\n" + } + ] + }, + "flags": {}, + "id": 3109, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3110, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Run", + "target": "958" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3111, + "module": "_resource_clients.run", + "name": "update", + "parsedDocstring": { + "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n", + "args": { + "status_message": "The new status message for the run.", + "is_status_message_terminal": "Set this flag to True if this is the final status message of the Actor run.", + "general_access": "Determines how others can access the run and its storages.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 501 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated run." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the run with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run\n" + } + ] + }, + "flags": {}, + "id": 3112, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new status message for the run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3113, + "kind": 32768, + "kindString": "Parameter", + "name": "status_message", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set this flag to True if this is the final status message of the Actor run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3114, + "kind": 32768, + "kindString": "Parameter", + "name": "is_status_message_terminal", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Determines how others can access the run and its storages." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3115, + "kind": 32768, + "kindString": "Parameter", + "name": "general_access", + "type": { + "name": "GeneralAccess | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "GeneralAccess", + "target": "1797" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3116, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run", + "type": "reference", + "target": "958" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3117, + "module": "_resource_clients.run", + "name": "abort", + "parsedDocstring": { + "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n", + "args": { + "gracefully": "If True, the Actor run will abort gracefully. It will send `aborting` and `persistStates`\nevents into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\nto resurrect the run later.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The data of the aborted Actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 530 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The data of the aborted Actor run." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Abort the Actor run which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run\n" + } + ] + }, + "flags": {}, + "id": 3118, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "abort", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, the Actor run will abort gracefully. It will send `aborting` and `persistStates`\nevents into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan\nto resurrect the run later." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3119, + "kind": 32768, + "kindString": "Parameter", + "name": "gracefully", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3120, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run", + "type": "reference", + "target": "958" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wait asynchronously until the run finishes or the server times out.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3121, + "module": "_resource_clients.run", + "name": "wait_for_finish", + "parsedDocstring": { + "text": "Wait asynchronously until the run finishes or the server times out.\n", + "args": { + "wait_duration": "How long does the client wait for run to finish. None for indefinite.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The Actor run data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the run has not yet finished." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 553 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The Actor run data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the run has not yet finished." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Wait asynchronously until the run finishes or the server times out.\n" + } + ] + }, + "flags": {}, + "id": 3122, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "wait_for_finish", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How long does the client wait for run to finish. None for indefinite." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3123, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_duration", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'no_timeout'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3124, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Run", + "target": "958" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3125, + "module": "_resource_clients.run", + "name": "delete", + "parsedDocstring": { + "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 577 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run\n" + } + ] + }, + "flags": {}, + "id": 3126, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3127, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3128, + "module": "_resource_clients.run", + "name": "metamorph", + "parsedDocstring": { + "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n", + "args": { + "target_actor_id": "ID of the target Actor that the run should be transformed into.", + "target_actor_build": "The build of the target Actor. It can be either a build tag or build number.\nBy default, the run uses the build specified in the default run configuration for the target Actor\n(typically the latest build).", + "run_input": "The input to pass to the new run.", + "content_type": "The content type of the input.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The Actor run data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 587 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The Actor run data." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Transform an Actor run into a run of another Actor with a new input.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run\n" + } + ] + }, + "flags": {}, + "id": 3129, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "metamorph", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the target Actor that the run should be transformed into." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3130, + "kind": 32768, + "kindString": "Parameter", + "name": "target_actor_id", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The build of the target Actor. It can be either a build tag or build number.\nBy default, the run uses the build specified in the default run configuration for the target Actor\n(typically the latest build)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3131, + "kind": 32768, + "kindString": "Parameter", + "name": "target_actor_build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The input to pass to the new run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3132, + "kind": 32768, + "kindString": "Parameter", + "name": "run_input", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the input." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3133, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3134, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run", + "type": "reference", + "target": "958" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3135, + "module": "_resource_clients.run", + "name": "resurrect", + "parsedDocstring": { + "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n", + "args": { + "build": "Which Actor build the resurrected run should use. It can be either a build tag or build number.\nBy default, the resurrected run uses the same build as before.", + "memory_mbytes": "New memory limit for the resurrected run, in megabytes. By default, the resurrected run\nuses the same memory limit as before.", + "run_timeout": "New timeout for the resurrected run. By default, the resurrected run uses the\nsame timeout as before.", + "max_items": "Maximum number of items that the resurrected pay-per-result run will return. By default, the\nresurrected run uses the same limit as before. Limit can be only increased.", + "max_total_charge_usd": "Maximum cost for the resurrected pay-per-event run in USD. By default, the\nresurrected run uses the same limit as before. Limit can be only increased.", + "restart_on_error": "Determines whether the resurrected run will be restarted if it fails.\nBy default, the resurrected run uses the same setting as before.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The Actor run data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 633 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The Actor run data." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Resurrect a finished Actor run.\n\nOnly finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected.\nRun status will be updated to RUNNING and its container will be restarted with the same default storages.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run\n" + } + ] + }, + "flags": {}, + "id": 3136, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "resurrect", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Which Actor build the resurrected run should use. It can be either a build tag or build number.\nBy default, the resurrected run uses the same build as before." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3137, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "New memory limit for the resurrected run, in megabytes. By default, the resurrected run\nuses the same memory limit as before." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3138, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "New timeout for the resurrected run. By default, the resurrected run uses the\nsame timeout as before." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3139, + "kind": 32768, + "kindString": "Parameter", + "name": "run_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of items that the resurrected pay-per-result run will return. By default, the\nresurrected run uses the same limit as before. Limit can be only increased." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3140, + "kind": 32768, + "kindString": "Parameter", + "name": "max_items", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum cost for the resurrected pay-per-event run in USD. By default, the\nresurrected run uses the same limit as before. Limit can be only increased." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3141, + "kind": 32768, + "kindString": "Parameter", + "name": "max_total_charge_usd", + "type": { + "name": "Decimal | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Decimal" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Determines whether the resurrected run will be restarted if it fails.\nBy default, the resurrected run uses the same setting as before." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3142, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3143, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run", + "type": "reference", + "target": "958" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3144, + "module": "_resource_clients.run", + "name": "reboot", + "parsedDocstring": { + "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The Actor run data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 688 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The Actor run data." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run\n" + } + ] + }, + "flags": {}, + "id": 3145, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "reboot", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3146, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run", + "type": "reference", + "target": "958" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3147, + "module": "_resource_clients.run", + "name": "dataset", + "parsedDocstring": { + "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n", + "returns": "A client allowing access to the default dataset of this Actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 707 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A client allowing access to the default dataset of this Actor run." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get the client for the default dataset of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" + } + ] + }, + "flags": {}, + "id": 3148, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "dataset", + "parameters": [], + "type": { + "name": "DatasetClientAsync", + "type": "reference", + "target": "2926" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3149, + "module": "_resource_clients.run", + "name": "key_value_store", + "parsedDocstring": { + "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n", + "returns": "A client allowing access to the default key-value store of this Actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 720 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A client allowing access to the default key-value store of this Actor run." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get the client for the default key-value store of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" + } + ] + }, + "flags": {}, + "id": 3150, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "key_value_store", + "parameters": [], + "type": { + "name": "KeyValueStoreClientAsync", + "type": "reference", + "target": "3683" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3151, + "module": "_resource_clients.run", + "name": "request_queue", + "parsedDocstring": { + "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n", + "returns": "A client allowing access to the default request_queue of this Actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 733 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A client allowing access to the default request_queue of this Actor run." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get the client for the default request queue of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" + } + ] + }, + "flags": {}, + "id": 3152, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "request_queue", + "parameters": [], + "type": { + "name": "RequestQueueClientAsync", + "type": "reference", + "target": "2078" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3153, + "module": "_resource_clients.run", + "name": "log", + "parsedDocstring": { + "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n", + "returns": "A client allowing access to the log of this Actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 746 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A client allowing access to the log of this Actor run." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get the client for the log of the Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages\n" + } + ] + }, + "flags": {}, + "id": 3154, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "log", + "parameters": [], + "type": { + "name": "LogClientAsync", + "type": "reference", + "target": "2177" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n`StreamedLog` can be explicitly started and stopped or used as a context manager.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3155, + "module": "_resource_clients.run", + "name": "get_streamed_log", + "parsedDocstring": { + "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n`StreamedLog` can be explicitly started and stopped or used as a context manager.\n", + "args": { + "to_logger": "`Logger` used for logging the redirected messages. If not provided, a new logger is created", + "from_start": "If `True`, all logs from the start of the Actor run will be redirected. If `False`, only newly\narrived logs will be redirected. This can be useful for redirecting only a small portion of relevant\nlogs for long-running Actors in stand-by.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "`StreamedLog` instance for redirected logs." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 759 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "`StreamedLog` instance for redirected logs." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get `StreamedLog` instance that can be used to redirect logs.\n\n`StreamedLog` can be explicitly started and stopped or used as a context manager.\n" + } + ] + }, + "flags": {}, + "id": 3156, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_streamed_log", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "`Logger` used for logging the redirected messages. If not provided, a new logger is created" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 3157, + "kind": 32768, + "kindString": "Parameter", + "name": "to_logger", + "type": { + "name": "logging.Logger | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "logging.Logger" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If `True`, all logs from the start of the Actor run will be redirected. If `False`, only newly\narrived logs will be redirected. This can be useful for redirecting only a small portion of relevant\nlogs for long-running Actors in stand-by." + } + ] + }, + "defaultValue": "True", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3158, + "kind": 32768, + "kindString": "Parameter", + "name": "from_start", + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3159, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "StreamedLogAsync", + "type": "reference", + "target": "61" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3160, + "module": "_resource_clients.run", + "name": "charge", + "parsedDocstring": { + "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n", + "args": { + "event_name": "The name of the event to charge for.", + "count": "The number of events to charge.", + "idempotency_key": "A unique key to ensure idempotent charging. If not provided,\none will be auto-generated.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 802 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Charge for an event of a Pay-Per-Event Actor run.\n\nhttps://docs.apify.com/api/v2#/reference/actor-runs/charge-events-in-run\n" + } + ] + }, + "flags": {}, + "id": 3161, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "charge", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the event to charge for." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3162, + "kind": 32768, + "kindString": "Parameter", + "name": "event_name", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of events to charge." + } + ] + }, + "defaultValue": "1", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3163, + "kind": 32768, + "kindString": "Parameter", + "name": "count", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique key to ensure idempotent charging. If not provided,\none will be auto-generated." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3164, + "kind": 32768, + "kindString": "Parameter", + "name": "idempotency_key", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3165, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3166, + "module": "_resource_clients.run", + "name": "get_status_message_watcher", + "parsedDocstring": { + "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n", + "args": { + "to_logger": "`Logger` used for logging the status and status messages. If not provided, a new logger is\ncreated.", + "check_period": "The period with which the status message will be polled.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "`StatusMessageWatcher` instance." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 848 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "`StatusMessageWatcher` instance." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get `StatusMessageWatcher` instance that can be used to redirect status and status messages to logs.\n\n`StatusMessageWatcher` can be explicitly started and stopped or used as a context manager.\n" + } + ] + }, + "flags": {}, + "id": 3167, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_status_message_watcher", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "`Logger` used for logging the status and status messages. If not provided, a new logger is\ncreated." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3168, + "kind": 32768, + "kindString": "Parameter", + "name": "to_logger", + "type": { + "name": "logging.Logger | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "logging.Logger" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The period with which the status message will be polled." + } + ] + }, + "defaultValue": "timedelta(seconds=1)", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3169, + "kind": 32768, + "kindString": "Parameter", + "name": "check_period", + "type": { + "name": "timedelta", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3170, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "StatusMessageWatcherAsync", + "type": "reference", + "target": "1676" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3980, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific Actor run.\n\nProvides methods to manage a specific Actor run, e.g. get it, update it, abort it, or wait for it to finish.\nObtain an instance via an appropriate method on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3103, + 3117, + 3160, + 3147, + 3125, + 3108, + 3166, + 3155, + 3149, + 3153, + 3128, + 3144, + 3151, + 3135, + 3111, + 3121 + ], + "title": "Methods" + }, + { + "children": [ + 3980 + ], + "title": "Properties" + } + ], + "id": 3102, + "module": "_resource_clients.run", + "name": "RunClientAsync", + "parsedDocstring": { + "text": "Sub-client for managing a specific Actor run.\n\nProvides methods to manage a specific Actor run, e.g. get it, update it, abort it, or wait for it to finish.\nObtain an instance via an appropriate method on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 465 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3172, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 25 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3177, + "module": "_resource_clients.build", + "name": "get", + "parsedDocstring": { + "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved Actor build data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 38 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved Actor build data." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n" + } + ] + }, + "flags": {}, + "id": 3178, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3179, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Build | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Build", + "target": "306" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3180, + "module": "_resource_clients.build", + "name": "delete", + "parsedDocstring": { + "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 54 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build\n" + } + ] + }, + "flags": {}, + "id": 3181, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3182, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3183, + "module": "_resource_clients.build", + "name": "abort", + "parsedDocstring": { + "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The data of the aborted Actor build." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 64 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The data of the aborted Actor build." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n" + } + ] + }, + "flags": {}, + "id": 3184, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "abort", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3185, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Build", + "type": "reference", + "target": "306" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3186, + "module": "_resource_clients.build", + "name": "get_open_api_definition", + "parsedDocstring": { + "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "OpenAPI definition of the Actor's build." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 84 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "OpenAPI definition of the Actor's build." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n" + } + ] + }, + "flags": {}, + "id": 3187, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_open_api_definition", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3188, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "dict", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wait synchronously until the build finishes or the server times out.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3189, + "module": "_resource_clients.build", + "name": "wait_for_finish", + "parsedDocstring": { + "text": "Wait synchronously until the build finishes or the server times out.\n", + "args": { + "wait_duration": "How long does the client wait for build to finish. None for indefinite.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The Actor build data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the build has not yet finished." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 102 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The Actor build data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the build has not yet finished." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Wait synchronously until the build finishes or the server times out.\n" + } + ] + }, + "flags": {}, + "id": 3190, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "wait_for_finish", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How long does the client wait for build to finish. None for indefinite." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3191, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_duration", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'no_timeout'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3192, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Build | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Build", + "target": "306" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3193, + "module": "_resource_clients.build", + "name": "log", + "parsedDocstring": { + "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n", + "returns": "A client allowing access to the log of this Actor build." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 123 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A client allowing access to the log of this Actor build." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n" + } + ] + }, + "flags": {}, + "id": 3194, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "log", + "parameters": [], + "type": { + "name": "LogClient", + "type": "reference", + "target": "2160" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 4008, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific Actor build.\n\nProvides methods to manage a specific Actor build, e.g. get it, abort it, or wait for it to finish. Obtain an\ninstance via an appropriate method on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3172, + 3183, + 3180, + 3177, + 3186, + 3193, + 3189 + ], + "title": "Methods" + }, + { + "children": [ + 4008 + ], + "title": "Properties" + } + ], + "id": 3171, + "module": "_resource_clients.build", + "name": "BuildClient", + "parsedDocstring": { + "text": "Sub-client for managing a specific Actor build.\n\nProvides methods to manage a specific Actor build, e.g. get it, abort it, or wait for it to finish. Obtain an\ninstance via an appropriate method on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 18 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3196, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 145 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3201, + "module": "_resource_clients.build", + "name": "get", + "parsedDocstring": { + "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved Actor build data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 158 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved Actor build data." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/build-object/get-build\n" + } + ] + }, + "flags": {}, + "id": 3202, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3203, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Build | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Build", + "target": "306" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3204, + "module": "_resource_clients.build", + "name": "abort", + "parsedDocstring": { + "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The data of the aborted Actor build." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 174 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The data of the aborted Actor build." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Abort the Actor build which is starting or currently running and return its details.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/abort-build/abort-build\n" + } + ] + }, + "flags": {}, + "id": 3205, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "abort", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3206, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Build", + "type": "reference", + "target": "306" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3207, + "module": "_resource_clients.build", + "name": "delete", + "parsedDocstring": { + "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 194 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the build.\n\nhttps://docs.apify.com/api/v2#/reference/actor-builds/delete-build/delete-build\n" + } + ] + }, + "flags": {}, + "id": 3208, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3209, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3210, + "module": "_resource_clients.build", + "name": "get_open_api_definition", + "parsedDocstring": { + "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "OpenAPI definition of the Actor's build." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 204 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "OpenAPI definition of the Actor's build." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return OpenAPI definition of the Actor's build.\n\nhttps://docs.apify.com/api/v2/actor-build-openapi-json-get\n" + } + ] + }, + "flags": {}, + "id": 3211, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_open_api_definition", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3212, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "dict", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wait asynchronously until the build finishes or the server times out.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3213, + "module": "_resource_clients.build", + "name": "wait_for_finish", + "parsedDocstring": { + "text": "Wait asynchronously until the build finishes or the server times out.\n", + "args": { + "wait_duration": "How long does the client wait for build to finish. None for indefinite.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The Actor build data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the build has not yet finished." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 222 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The Actor build data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED,\nTIMED_OUT, ABORTED), then the build has not yet finished." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Wait asynchronously until the build finishes or the server times out.\n" + } + ] + }, + "flags": {}, + "id": 3214, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "wait_for_finish", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How long does the client wait for build to finish. None for indefinite." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3215, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_duration", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'no_timeout'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3216, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Build | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Build", + "target": "306" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3217, + "module": "_resource_clients.build", + "name": "log", + "parsedDocstring": { + "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n", + "returns": "A client allowing access to the log of this Actor build." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 243 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A client allowing access to the log of this Actor build." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get the client for the log of the Actor build.\n\nhttps://docs.apify.com/api/v2/#/reference/actor-builds/build-log/get-log\n" + } + ] + }, + "flags": {}, + "id": 3218, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "log", + "parameters": [], + "type": { + "name": "LogClientAsync", + "type": "reference", + "target": "2177" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3981, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific Actor build.\n\nProvides methods to manage a specific Actor build, e.g. get it, abort it, or wait for it to finish. Obtain an\ninstance via an appropriate method on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3196, + 3204, + 3207, + 3201, + 3210, + 3217, + 3213 + ], + "title": "Methods" + }, + { + "children": [ + 3981 + ], + "title": "Properties" + } + ], + "id": 3195, + "module": "_resource_clients.build", + "name": "BuildClientAsync", + "parsedDocstring": { + "text": "Sub-client for managing a specific Actor build.\n\nProvides methods to manage a specific Actor build, e.g. get it, abort it, or wait for it to finish. Obtain an\ninstance via an appropriate method on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/build.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 138 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3220, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 31 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3224, + "module": "_resource_clients.schedule_collection", + "name": "list", + "parsedDocstring": { + "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n", + "args": { + "limit": "How many schedules to retrieve.", + "offset": "What schedules to include as first when retrieving the list.", + "desc": "Whether to sort the schedules in descending order based on their modification date.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available schedules matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 42 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available schedules matching the specified filters." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n" + } + ] + }, + "flags": {}, + "id": 3225, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many schedules to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3226, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What schedules to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3227, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the schedules in descending order based on their modification date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3228, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3229, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfSchedules", + "type": "reference", + "target": "771" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available schedules.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3230, + "module": "_resource_clients.schedule_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over the available schedules.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n", + "args": { + "limit": "How many schedules to retrieve.", + "offset": "What schedules to include as first when retrieving the list.", + "desc": "Whether to sort the schedules in descending order based on their modification date.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 66 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available schedules.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n" + } + ] + }, + "flags": {}, + "id": 3231, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many schedules to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3232, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What schedules to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3233, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the schedules in descending order based on their modification date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3234, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3235, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ScheduleShort", + "target": "1152" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3236, + "module": "_resource_clients.schedule_collection", + "name": "create", + "parsedDocstring": { + "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n", + "args": { + "cron_expression": "The cron expression used by this schedule.", + "is_enabled": "True if the schedule should be enabled.", + "is_exclusive": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule.", + "name": "The name of the schedule to create.", + "actions": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure.", + "description": "Description of this schedule.", + "timezone": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones).", + "title": "Title of this schedule.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The created schedule." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 96 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The created schedule." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n" + } + ] + }, + "flags": {}, + "id": 3237, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "create", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cron expression used by this schedule." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3238, + "kind": 32768, + "kindString": "Parameter", + "name": "cron_expression", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "True if the schedule should be enabled." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3239, + "kind": 32768, + "kindString": "Parameter", + "name": "is_enabled", + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3240, + "kind": 32768, + "kindString": "Parameter", + "name": "is_exclusive", + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the schedule to create." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3241, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3242, + "kind": 32768, + "kindString": "Parameter", + "name": "actions", + "type": { + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Description of this schedule." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3243, + "kind": 32768, + "kindString": "Parameter", + "name": "description", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3244, + "kind": 32768, + "kindString": "Parameter", + "name": "timezone", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Title of this schedule." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3245, + "kind": 32768, + "kindString": "Parameter", + "name": "title", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3246, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Schedule", + "type": "reference", + "target": "1115" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 4009, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the schedule collection.\n\nProvides methods to manage the schedule collection, e.g. list or create schedules. Obtain an instance via an\nappropriate method on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3220, + 3236, + 3230, + 3224 + ], + "title": "Methods" + }, + { + "children": [ + 4009 + ], + "title": "Properties" + } + ], + "id": 3219, + "module": "_resource_clients.schedule_collection", + "name": "ScheduleCollectionClient", + "parsedDocstring": { + "text": "Sub-client for the schedule collection.\n\nProvides methods to manage the schedule collection, e.g. list or create schedules. Obtain an instance via an\nappropriate method on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 24 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3248, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 154 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3252, + "module": "_resource_clients.schedule_collection", + "name": "list", + "parsedDocstring": { + "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n", + "args": { + "limit": "How many schedules to retrieve.", + "offset": "What schedules to include as first when retrieving the list.", + "desc": "Whether to sort the schedules in descending order based on their modification date.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available schedules matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 165 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available schedules matching the specified filters." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the available schedules.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n" + } + ] + }, + "flags": {}, + "id": 3253, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many schedules to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3254, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What schedules to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3255, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the schedules in descending order based on their modification date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3256, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3257, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfSchedules", + "type": "reference", + "target": "771" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available schedules.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3258, + "module": "_resource_clients.schedule_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over the available schedules.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n", + "args": { + "limit": "How many schedules to retrieve.", + "offset": "What schedules to include as first when retrieving the list.", + "desc": "Whether to sort the schedules in descending order based on their modification date.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 189 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available schedules.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/get-list-of-schedules\n" + } + ] + }, + "flags": {}, + "id": 3259, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many schedules to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3260, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What schedules to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3261, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the schedules in descending order based on their modification date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3262, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3263, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ScheduleShort", + "target": "1152" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3264, + "module": "_resource_clients.schedule_collection", + "name": "create", + "parsedDocstring": { + "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n", + "args": { + "cron_expression": "The cron expression used by this schedule.", + "is_enabled": "True if the schedule should be enabled.", + "is_exclusive": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule.", + "name": "The name of the schedule to create.", + "actions": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure.", + "description": "Description of this schedule.", + "timezone": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones).", + "title": "Title of this schedule.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The created schedule." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 219 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The created schedule." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Create a new schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedules-collection/create-schedule\n" + } + ] + }, + "flags": {}, + "id": 3265, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "create", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cron expression used by this schedule." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3266, + "kind": 32768, + "kindString": "Parameter", + "name": "cron_expression", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "True if the schedule should be enabled." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3267, + "kind": 32768, + "kindString": "Parameter", + "name": "is_enabled", + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "When set to true, don't start Actor or Actor task if it's still running from the previous\nschedule." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3268, + "kind": 32768, + "kindString": "Parameter", + "name": "is_exclusive", + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the schedule to create." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3269, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3270, + "kind": 32768, + "kindString": "Parameter", + "name": "actions", + "type": { + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Description of this schedule." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3271, + "kind": 32768, + "kindString": "Parameter", + "name": "description", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timezone in which your cron expression runs (TZ database name from\nhttps://en.wikipedia.org/wiki/List_of_tz_database_time_zones)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3272, + "kind": 32768, + "kindString": "Parameter", + "name": "timezone", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Title of this schedule." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3273, + "kind": 32768, + "kindString": "Parameter", + "name": "title", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3274, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Schedule", + "type": "reference", + "target": "1115" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3982, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the schedule collection.\n\nProvides methods to manage the schedule collection, e.g. list or create schedules. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3248, + 3264, + 3258, + 3252 + ], + "title": "Methods" + }, + { + "children": [ + 3982 + ], + "title": "Properties" + } + ], + "id": 3247, + "module": "_resource_clients.schedule_collection", + "name": "ScheduleCollectionClientAsync", + "parsedDocstring": { + "text": "Sub-client for the schedule collection.\n\nProvides methods to manage the schedule collection, e.g. list or create schedules. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/schedule_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 147 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3276, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 38 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3280, + "module": "_resource_clients.actor_version_collection", + "name": "list", + "parsedDocstring": { + "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available Actor versions." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 49 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available Actor versions." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n" + } + ] + }, + "flags": {}, + "id": 3281, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3282, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfVersions", + "type": "reference", + "target": "700" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available Actor versions.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more\nversions than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3283, + "module": "_resource_clients.actor_version_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over the available Actor versions.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more\nversions than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 63 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available Actor versions.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more\nversions than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n" + } + ] + }, + "flags": {}, + "id": 3284, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3285, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Version", + "target": "1336" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3286, + "module": "_resource_clients.actor_version_collection", + "name": "create", + "parsedDocstring": { + "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n", + "args": { + "version_number": "Major and minor version of the Actor (e.g. `1.0`).", + "build_tag": "Tag that is automatically set to the latest successful build of the current version.", + "env_vars": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure.", + "apply_env_vars_to_build": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process.", + "source_type": "What source type is the Actor version using.", + "source_files": "Source code comprised of multiple files, each an item of the array. Required\nwhen `source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure.", + "git_repo_url": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`.", + "tarball_url": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`.", + "github_gist_url": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The created Actor version." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 81 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The created Actor version." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n" + } + ] + }, + "flags": {}, + "id": 3287, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "create", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Major and minor version of the Actor (e.g. `1.0`)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3288, + "kind": 32768, + "kindString": "Parameter", + "name": "version_number", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tag that is automatically set to the latest successful build of the current version." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3289, + "kind": 32768, + "kindString": "Parameter", + "name": "build_tag", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3290, + "kind": 32768, + "kindString": "Parameter", + "name": "env_vars", + "type": { + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3291, + "kind": 32768, + "kindString": "Parameter", + "name": "apply_env_vars_to_build", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What source type is the Actor version using." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3292, + "kind": 32768, + "kindString": "Parameter", + "name": "source_type", + "type": { + "name": "VersionSourceType", + "type": "reference", + "target": "1802" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Source code comprised of multiple files, each an item of the array. Required\nwhen `source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3293, + "kind": 32768, + "kindString": "Parameter", + "name": "source_files", + "type": { + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3294, + "kind": 32768, + "kindString": "Parameter", + "name": "git_repo_url", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3295, + "kind": 32768, + "kindString": "Parameter", + "name": "tarball_url", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3296, + "kind": 32768, + "kindString": "Parameter", + "name": "github_gist_url", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3297, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Version", + "type": "reference", + "target": "1336" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 4010, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the Actor version collection.\n\nProvides methods to manage Actor versions, e.g. list or create them. Obtain an instance via an appropriate method\non the `ActorClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3276, + 3286, + 3283, + 3280 + ], + "title": "Methods" + }, + { + "children": [ + 4010 + ], + "title": "Properties" + } + ], + "id": 3275, + "module": "_resource_clients.actor_version_collection", + "name": "ActorVersionCollectionClient", + "parsedDocstring": { + "text": "Sub-client for the Actor version collection.\n\nProvides methods to manage Actor versions, e.g. list or create them. Obtain an instance via an appropriate method\non the `ActorClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 31 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3299, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 143 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3303, + "module": "_resource_clients.actor_version_collection", + "name": "list", + "parsedDocstring": { + "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available Actor versions." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 154 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available Actor versions." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the available Actor versions.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n" + } + ] + }, + "flags": {}, + "id": 3304, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3305, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfVersions", + "type": "reference", + "target": "700" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available Actor versions.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more\nversions than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3306, + "module": "_resource_clients.actor_version_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over the available Actor versions.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more\nversions than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 168 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available Actor versions.\n\nThe underlying API endpoint does not support pagination, so this method performs a single API call and yields\nthe items from its response. If the endpoint returns more items than fit in one response (the API caps the page\nsize), the rest are not returned. In practice this is rarely a concern — Actors are not expected to have more\nversions than the cap.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/get-list-of-versions\n" + } + ] + }, + "flags": {}, + "id": 3307, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3308, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Version", + "target": "1336" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3309, + "module": "_resource_clients.actor_version_collection", + "name": "create", + "parsedDocstring": { + "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n", + "args": { + "version_number": "Major and minor version of the Actor (e.g. `1.0`).", + "build_tag": "Tag that is automatically set to the latest successful build of the current version.", + "env_vars": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure.", + "apply_env_vars_to_build": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process.", + "source_type": "What source type is the Actor version using.", + "source_files": "Source code comprised of multiple files, each an item of the array. Required\nwhen `source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure.", + "git_repo_url": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`.", + "tarball_url": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`.", + "github_gist_url": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The created Actor version." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 187 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The created Actor version." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Create a new Actor version.\n\nhttps://docs.apify.com/api/v2#/reference/actors/version-collection/create-version\n" + } + ] + }, + "flags": {}, + "id": 3310, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "create", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Major and minor version of the Actor (e.g. `1.0`)." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3311, + "kind": 32768, + "kindString": "Parameter", + "name": "version_number", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tag that is automatically set to the latest successful build of the current version." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3312, + "kind": 32768, + "kindString": "Parameter", + "name": "build_tag", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Environment variables that will be available to the Actor run process, and optionally\nalso to the build process. See the API docs for their exact structure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3313, + "kind": 32768, + "kindString": "Parameter", + "name": "env_vars", + "type": { + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the environment variables specified for the Actor run will also\nbe set to the Actor build process." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3314, + "kind": 32768, + "kindString": "Parameter", + "name": "apply_env_vars_to_build", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What source type is the Actor version using." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3315, + "kind": 32768, + "kindString": "Parameter", + "name": "source_type", + "type": { + "name": "VersionSourceType", + "type": "reference", + "target": "1802" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Source code comprised of multiple files, each an item of the array. Required\nwhen `source_type` is `'SOURCE_FILES'`. See the API docs for the exact structure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3316, + "kind": 32768, + "kindString": "Parameter", + "name": "source_files", + "type": { + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of a Git repository from which the source code will be cloned.\nRequired when `source_type` is `'GIT_REPO'`." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3317, + "kind": 32768, + "kindString": "Parameter", + "name": "git_repo_url", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of a tarball or a zip archive from which the source code will be downloaded.\nRequired when `source_type` is `'TARBALL'`." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3318, + "kind": 32768, + "kindString": "Parameter", + "name": "tarball_url", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when `source_type` is `'GITHUB_GIST'`." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3319, + "kind": 32768, + "kindString": "Parameter", + "name": "github_gist_url", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3320, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Version", + "type": "reference", + "target": "1336" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3983, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the Actor version collection.\n\nProvides methods to manage Actor versions, e.g. list or create them. Obtain an instance via an appropriate method\non the `ActorClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3299, + 3309, + 3306, + 3303 + ], + "title": "Methods" + }, + { + "children": [ + 3983 + ], + "title": "Properties" + } + ], + "id": 3298, + "module": "_resource_clients.actor_version_collection", + "name": "ActorVersionCollectionClientAsync", + "parsedDocstring": { + "text": "Sub-client for the Actor version collection.\n\nProvides methods to manage Actor versions, e.g. list or create them. Obtain an instance via an appropriate method\non the `ActorClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_version_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 136 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3322, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 31 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3326, + "module": "_resource_clients.dataset_collection", + "name": "list", + "parsedDocstring": { + "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n", + "args": { + "unnamed": "Whether to include unnamed datasets in the list.", + "limit": "How many datasets to retrieve.", + "offset": "What dataset to include as first when retrieving the list.", + "desc": "Whether to sort the datasets in descending order based on their modification date.", + "ownership": "Filter by ownership. `'ownedByMe'` returns only user's own datasets,\n`'sharedWithMe'` returns only datasets shared with the user.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available datasets matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 42 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available datasets matching the specified filters." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n" + } + ] + }, + "flags": {}, + "id": 3327, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to include unnamed datasets in the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3328, + "kind": 32768, + "kindString": "Parameter", + "name": "unnamed", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many datasets to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3329, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What dataset to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3330, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the datasets in descending order based on their modification date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3331, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by ownership. `'ownedByMe'` returns only user's own datasets,\n`'sharedWithMe'` returns only datasets shared with the user." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3332, + "kind": 32768, + "kindString": "Parameter", + "name": "ownership", + "type": { + "name": "StorageOwnership | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "StorageOwnership", + "target": "1801" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3333, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfDatasets", + "type": "reference", + "target": "759" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available datasets.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3334, + "module": "_resource_clients.dataset_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over the available datasets.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n", + "args": { + "unnamed": "Whether to include unnamed datasets in the list.", + "limit": "How many datasets to retrieve.", + "offset": "What dataset to include as first when retrieving the list.", + "desc": "Whether to sort the datasets in descending order based on their modification date.", + "ownership": "Filter by ownership. 'ownedByMe' returns only user's own datasets,\n'sharedWithMe' returns only datasets shared with the user.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 78 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available datasets.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n" + } + ] + }, + "flags": {}, + "id": 3335, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to include unnamed datasets in the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3336, + "kind": 32768, + "kindString": "Parameter", + "name": "unnamed", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many datasets to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3337, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What dataset to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3338, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the datasets in descending order based on their modification date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3339, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by ownership. 'ownedByMe' returns only user's own datasets,\n'sharedWithMe' returns only datasets shared with the user." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3340, + "kind": 32768, + "kindString": "Parameter", + "name": "ownership", + "type": { + "name": "StorageOwnership | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "StorageOwnership", + "target": "1801" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3341, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "DatasetListItem", + "target": "457" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3342, + "module": "_resource_clients.dataset_collection", + "name": "get_or_create", + "parsedDocstring": { + "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n", + "args": { + "name": "The name of the dataset to retrieve or create.", + "schema": "The schema of the dataset.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved or newly-created dataset." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 115 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved or newly-created dataset." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n" + } + ] + }, + "flags": {}, + "id": 3343, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_or_create", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the dataset to retrieve or create." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3344, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The schema of the dataset." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3345, + "kind": 32768, + "kindString": "Parameter", + "name": "schema", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3346, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Dataset", + "type": "reference", + "target": "432" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 4011, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the dataset collection.\n\nProvides methods to manage the dataset collection, e.g. list or create datasets. Obtain an instance via an\nappropriate method on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3322, + 3342, + 3334, + 3326 + ], + "title": "Methods" + }, + { + "children": [ + 4011 + ], + "title": "Properties" + } + ], + "id": 3321, + "module": "_resource_clients.dataset_collection", + "name": "DatasetCollectionClient", + "parsedDocstring": { + "text": "Sub-client for the dataset collection.\n\nProvides methods to manage the dataset collection, e.g. list or create datasets. Obtain an instance via an\nappropriate method on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 24 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3348, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 146 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3352, + "module": "_resource_clients.dataset_collection", + "name": "list", + "parsedDocstring": { + "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n", + "args": { + "unnamed": "Whether to include unnamed datasets in the list.", + "limit": "How many datasets to retrieve.", + "offset": "What dataset to include as first when retrieving the list.", + "desc": "Whether to sort the datasets in descending order based on their modification date.", + "ownership": "Filter by ownership. `'ownedByMe'` returns only user's own datasets,\n`'sharedWithMe'` returns only datasets shared with the user.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available datasets matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 157 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available datasets matching the specified filters." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the available datasets.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n" + } + ] + }, + "flags": {}, + "id": 3353, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to include unnamed datasets in the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3354, + "kind": 32768, + "kindString": "Parameter", + "name": "unnamed", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many datasets to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3355, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What dataset to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3356, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the datasets in descending order based on their modification date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3357, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by ownership. `'ownedByMe'` returns only user's own datasets,\n`'sharedWithMe'` returns only datasets shared with the user." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3358, + "kind": 32768, + "kindString": "Parameter", + "name": "ownership", + "type": { + "name": "StorageOwnership | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "StorageOwnership", + "target": "1801" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3359, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfDatasets", + "type": "reference", + "target": "759" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available datasets.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3360, + "module": "_resource_clients.dataset_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over the available datasets.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n", + "args": { + "unnamed": "Whether to include unnamed datasets in the list.", + "limit": "How many datasets to retrieve.", + "offset": "What dataset to include as first when retrieving the list.", + "desc": "Whether to sort the datasets in descending order based on their modification date.", + "ownership": "Filter by ownership. 'ownedByMe' returns only user's own datasets,\n'sharedWithMe' returns only datasets shared with the user.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 193 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available datasets.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets\n" + } + ] + }, + "flags": {}, + "id": 3361, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to include unnamed datasets in the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3362, + "kind": 32768, + "kindString": "Parameter", + "name": "unnamed", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many datasets to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3363, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What dataset to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3364, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the datasets in descending order based on their modification date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3365, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter by ownership. 'ownedByMe' returns only user's own datasets,\n'sharedWithMe' returns only datasets shared with the user." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3366, + "kind": 32768, + "kindString": "Parameter", + "name": "ownership", + "type": { + "name": "StorageOwnership | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "StorageOwnership", + "target": "1801" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3367, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "DatasetListItem", + "target": "457" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3368, + "module": "_resource_clients.dataset_collection", + "name": "get_or_create", + "parsedDocstring": { + "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n", + "args": { + "name": "The name of the dataset to retrieve or create.", + "schema": "The schema of the dataset.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved or newly-created dataset." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 230 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved or newly-created dataset." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve a named dataset, or create a new one when it doesn't exist.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset\n" + } + ] + }, + "flags": {}, + "id": 3369, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_or_create", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the dataset to retrieve or create." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3370, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The schema of the dataset." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3371, + "kind": 32768, + "kindString": "Parameter", + "name": "schema", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3372, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Dataset", + "type": "reference", + "target": "432" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3984, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the dataset collection.\n\nProvides methods to manage the dataset collection, e.g. list or create datasets. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3348, + 3368, + 3360, + 3352 + ], + "title": "Methods" + }, + { + "children": [ + 3984 + ], + "title": "Properties" + } + ], + "id": 3347, + "module": "_resource_clients.dataset_collection", + "name": "DatasetCollectionClientAsync", + "parsedDocstring": { + "text": "Sub-client for the dataset collection.\n\nProvides methods to manage the dataset collection, e.g. list or create datasets. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/dataset_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 139 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3374, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 38 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3375, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3376, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3377, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3378, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3379, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3380, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3381, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3382, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3383, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class with shared implementation for sync and async resource clients.\n\nProvides URL building, parameter handling, and client creation utilities." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 3374 + ], + "title": "Methods" + }, + { + "children": [ + 3383 + ], + "title": "Properties" + } + ], + "id": 3373, + "module": "_resource_clients._resource_client", + "name": "ResourceClientBase", + "parsedDocstring": { + "text": "Base class with shared implementation for sync and async resource clients.\n\nProvides URL building, parameter handling, and client creation utilities." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 32 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + }, + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3385, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 174 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientBase.__init__", + "target": 3374, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3962, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for synchronous resource clients." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3385 + ], + "title": "Methods" + }, + { + "children": [ + 3962 + ], + "title": "Properties" + } + ], + "id": 3384, + "module": "_resource_clients._resource_client", + "name": "ResourceClient", + "parsedDocstring": { + "text": "Base class for synchronous resource clients." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 171 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientBase", + "target": "3373", + "type": "reference" + } + ], + "extendedBy": [ + { + "name": "ScheduleClient", + "target": "1904", + "type": "reference" + }, + { + "name": "UserClient", + "target": "1956", + "type": "reference" + }, + { + "name": "RequestQueueClient", + "target": "1996", + "type": "reference" + }, + { + "name": "LogClient", + "target": "2160", + "type": "reference" + }, + { + "name": "ActorEnvVarCollectionClient", + "target": "2194", + "type": "reference" + }, + { + "name": "WebhookDispatchCollectionClient", + "target": "2228", + "type": "reference" + }, + { + "name": "ActorCollectionClient", + "target": "2262", + "type": "reference" + }, + { + "name": "WebhookDispatchClient", + "target": "2354", + "type": "reference" + }, + { + "name": "KeyValueStoreCollectionClient", + "target": "2372", + "type": "reference" + }, + { + "name": "ActorVersionClient", + "target": "2424", + "type": "reference" + }, + { + "name": "RequestQueueCollectionClient", + "target": "2480", + "type": "reference" + }, + { + "name": "TaskCollectionClient", + "target": "2530", + "type": "reference" + }, + { + "name": "StoreCollectionClient", + "target": "2598", + "type": "reference" + }, + { + "name": "TaskClient", + "target": "2648", + "type": "reference" + }, + { + "name": "BuildCollectionClient", + "target": "2778", + "type": "reference" + }, + { + "name": "DatasetClient", + "target": "2819", + "type": "reference" + }, + { + "name": "RunClient", + "target": "3033", + "type": "reference" + }, + { + "name": "BuildClient", + "target": "3171", + "type": "reference" + }, + { + "name": "ScheduleCollectionClient", + "target": "3219", + "type": "reference" + }, + { + "name": "ActorVersionCollectionClient", + "target": "3275", + "type": "reference" + }, + { + "name": "DatasetCollectionClient", + "target": "3321", + "type": "reference" + }, + { + "name": "ActorClient", + "target": "3404", + "type": "reference" + }, + { + "name": "KeyValueStoreClient", + "target": "3608", + "type": "reference" + }, + { + "name": "ActorEnvVarClient", + "target": "3758", + "type": "reference" + }, + { + "name": "WebhookCollectionClient", + "target": "3794", + "type": "reference" + }, + { + "name": "WebhookClient", + "target": "3856", + "type": "reference" + }, + { + "name": "RunCollectionClient", + "target": "3916", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3395, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 366 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientBase.__init__", + "target": 3374, + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3963, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for asynchronous resource clients." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3395 + ], + "title": "Methods" + }, + { + "children": [ + 3963 + ], + "title": "Properties" + } + ], + "id": 3394, + "module": "_resource_clients._resource_client", + "name": "ResourceClientAsync", + "parsedDocstring": { + "text": "Base class for asynchronous resource clients." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 363 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientBase", + "target": "3373", + "type": "reference" + } + ], + "extendedBy": [ + { + "name": "ScheduleClientAsync", + "target": "1930", + "type": "reference" + }, + { + "name": "UserClientAsync", + "target": "1976", + "type": "reference" + }, + { + "name": "RequestQueueClientAsync", + "target": "2078", + "type": "reference" + }, + { + "name": "LogClientAsync", + "target": "2177", + "type": "reference" + }, + { + "name": "ActorEnvVarCollectionClientAsync", + "target": "2211", + "type": "reference" + }, + { + "name": "WebhookDispatchCollectionClientAsync", + "target": "2245", + "type": "reference" + }, + { + "name": "ActorCollectionClientAsync", + "target": "2308", + "type": "reference" + }, + { + "name": "WebhookDispatchClientAsync", + "target": "2363", + "type": "reference" + }, + { + "name": "KeyValueStoreCollectionClientAsync", + "target": "2398", + "type": "reference" + }, + { + "name": "ActorVersionClientAsync", + "target": "2452", + "type": "reference" + }, + { + "name": "RequestQueueCollectionClientAsync", + "target": "2505", + "type": "reference" + }, + { + "name": "TaskCollectionClientAsync", + "target": "2564", + "type": "reference" + }, + { + "name": "StoreCollectionClientAsync", + "target": "2623", + "type": "reference" + }, + { + "name": "TaskClientAsync", + "target": "2713", + "type": "reference" + }, + { + "name": "BuildCollectionClientAsync", + "target": "2795", + "type": "reference" + }, + { + "name": "DatasetClientAsync", + "target": "2926", + "type": "reference" + }, + { + "name": "RunClientAsync", + "target": "3102", + "type": "reference" + }, + { + "name": "BuildClientAsync", + "target": "3195", + "type": "reference" + }, + { + "name": "ScheduleCollectionClientAsync", + "target": "3247", + "type": "reference" + }, + { + "name": "ActorVersionCollectionClientAsync", + "target": "3298", + "type": "reference" + }, + { + "name": "DatasetCollectionClientAsync", + "target": "3347", + "type": "reference" + }, + { + "name": "ActorClientAsync", + "target": "3506", + "type": "reference" + }, + { + "name": "KeyValueStoreClientAsync", + "target": "3683", + "type": "reference" + }, + { + "name": "ActorEnvVarClientAsync", + "target": "3776", + "type": "reference" + }, + { + "name": "WebhookCollectionClientAsync", + "target": "3825", + "type": "reference" + }, + { + "name": "WebhookClientAsync", + "target": "3886", + "type": "reference" + }, + { + "name": "RunCollectionClientAsync", + "target": "3939", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3405, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 74 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3410, + "module": "_resource_clients.actor", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 87 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved Actor." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n" + } + ] + }, + "flags": {}, + "id": 3411, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3412, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Actor | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Actor", + "target": "192" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3413, + "module": "_resource_clients.actor", + "name": "update", + "parsedDocstring": { + "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n", + "args": { + "name": "The name of the Actor.", + "title": "The title of the Actor (human-readable).", + "description": "The description for the Actor.", + "seo_title": "The title of the Actor optimized for search engines.", + "seo_description": "The description of the Actor optimized for search engines.", + "versions": "The list of Actor versions.", + "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.", + "is_public": "Whether the Actor is public.", + "is_deprecated": "Whether the Actor is deprecated.", + "categories": "The categories to which the Actor belongs to.", + "default_run_build": "Tag or number of the build that you want to run by default.", + "default_run_max_items": "Default limit of the number of results that will be returned\nby runs of this Actor, if the Actor is charged per result.", + "default_run_memory_mbytes": "Default amount of memory allocated for the runs of this Actor, in megabytes.", + "default_run_timeout": "Default timeout for the runs of this Actor.", + "example_run_input_body": "Input to be prefilled as default input to new users of this Actor.", + "example_run_input_content_type": "The content type of the example run input.", + "actor_standby_is_enabled": "Whether the Actor Standby is enabled.", + "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.", + "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.", + "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.", + "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.", + "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.", + "pricing_infos": "A list of objects that describes the pricing of the Actor.", + "actor_permission_level": "The permission level of the Actor on Apify platform.", + "tagged_builds": "A dictionary mapping build tag names to their settings. Use it to create, update,\nor remove build tags. To assign a tag, provide a dict with 'buildId' key. To remove a tag,\nset its value to None. Example: {'latest': {'buildId': 'abc'}, 'beta': None}.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 103 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated Actor." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n" + } + ] + }, + "flags": {}, + "id": 3414, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3415, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the Actor (human-readable)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3416, + "kind": 32768, + "kindString": "Parameter", + "name": "title", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description for the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3417, + "kind": 32768, + "kindString": "Parameter", + "name": "description", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the Actor optimized for search engines." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3418, + "kind": 32768, + "kindString": "Parameter", + "name": "seo_title", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the Actor optimized for search engines." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3419, + "kind": 32768, + "kindString": "Parameter", + "name": "seo_description", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of Actor versions." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3420, + "kind": 32768, + "kindString": "Parameter", + "name": "versions", + "type": { + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3421, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Actor is public." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3422, + "kind": 32768, + "kindString": "Parameter", + "name": "is_public", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Actor is deprecated." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3423, + "kind": 32768, + "kindString": "Parameter", + "name": "is_deprecated", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The categories to which the Actor belongs to." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3424, + "kind": 32768, + "kindString": "Parameter", + "name": "categories", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tag or number of the build that you want to run by default." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3425, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default limit of the number of results that will be returned\nby runs of this Actor, if the Actor is charged per result." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3426, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_max_items", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default amount of memory allocated for the runs of this Actor, in megabytes." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3427, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for the runs of this Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3428, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input to be prefilled as default input to new users of this Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3429, + "kind": 32768, + "kindString": "Parameter", + "name": "example_run_input_body", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the example run input." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3430, + "kind": 32768, + "kindString": "Parameter", + "name": "example_run_input_content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Actor Standby is enabled." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3431, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_is_enabled", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3432, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_desired_requests_per_actor_run", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3433, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_max_requests_per_actor_run", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If the Actor run does not receive any requests for this time,\nit will be shut down." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3434, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_idle_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The build tag or number to run when the Actor is in Standby mode." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3435, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The memory in megabytes to use when the Actor is in Standby mode." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3436, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of objects that describes the pricing of the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3437, + "kind": 32768, + "kindString": "Parameter", + "name": "pricing_infos", + "type": { + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The permission level of the Actor on Apify platform." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3438, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_permission_level", + "type": { + "name": "ActorPermissionLevel | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorPermissionLevel", + "target": "1795" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A dictionary mapping build tag names to their settings. Use it to create, update,\nor remove build tags. To assign a tag, provide a dict with 'buildId' key. To remove a tag,\nset its value to None. Example: {'latest': {'buildId': 'abc'}, 'beta': None}." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3439, + "kind": 32768, + "kindString": "Parameter", + "name": "tagged_builds", + "type": { + "name": "dict[str, None | dict[str, str]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "str" + } + ] + } + ] + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3440, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Actor", + "type": "reference", + "target": "192" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3441, + "module": "_resource_clients.actor", + "name": "delete", + "parsedDocstring": { + "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 211 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor\n" + } + ] + }, + "flags": {}, + "id": 3442, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3443, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3444, + "module": "_resource_clients.actor", + "name": "start", + "parsedDocstring": { + "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n", + "args": { + "run_input": "The input to pass to the Actor run.", + "content_type": "The content type of the input.", + "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest).", + "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit.", + "max_total_charge_usd": "A limit on the total charged amount for pay-per-event Actors.", + "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.", + "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor.", + "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor.", + "force_permission_level": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings.", + "wait_for_finish": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60.", + "webhooks": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The run object." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 221 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The run object." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n" + } + ] + }, + "flags": {}, + "id": 3445, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "start", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The input to pass to the Actor run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3446, + "kind": 32768, + "kindString": "Parameter", + "name": "run_input", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the input." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3447, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3448, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3449, + "kind": 32768, + "kindString": "Parameter", + "name": "max_items", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A limit on the total charged amount for pay-per-event Actors." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3450, + "kind": 32768, + "kindString": "Parameter", + "name": "max_total_charge_usd", + "type": { + "name": "Decimal | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Decimal" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3451, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3452, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3453, + "kind": 32768, + "kindString": "Parameter", + "name": "run_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3454, + "kind": 32768, + "kindString": "Parameter", + "name": "force_permission_level", + "type": { + "name": "ActorPermissionLevel | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorPermissionLevel", + "target": "1795" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3455, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_for_finish", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3456, + "kind": 32768, + "kindString": "Parameter", + "name": "webhooks", + "type": { + "name": "WebhooksList | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "WebhooksList", + "target": "14" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3457, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run", + "type": "reference", + "target": "958" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3458, + "module": "_resource_clients.actor", + "name": "call", + "parsedDocstring": { + "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n", + "args": { + "run_input": "The input to pass to the Actor run.", + "content_type": "The content type of the input.", + "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest).", + "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit.", + "max_total_charge_usd": "A limit on the total charged amount for pay-per-event Actors.", + "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.", + "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor.", + "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor.", + "force_permission_level": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings.", + "webhooks": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here.", + "wait_duration": "The maximum time the server waits for the run to finish. If not provided,\nwaits indefinitely.", + "logger": "Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\ndefault logger will be used. Setting `None` will disable any log propagation. Passing custom logger\nwill redirect logs to the provided logger. The logger is also used to capture status and status message\nof the other Actor run.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The run object." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 297 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The run object." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n" + } + ] + }, + "flags": {}, + "id": 3459, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "call", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The input to pass to the Actor run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3460, + "kind": 32768, + "kindString": "Parameter", + "name": "run_input", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the input." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3461, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3462, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3463, + "kind": 32768, + "kindString": "Parameter", + "name": "max_items", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A limit on the total charged amount for pay-per-event Actors." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3464, + "kind": 32768, + "kindString": "Parameter", + "name": "max_total_charge_usd", + "type": { + "name": "Decimal | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Decimal" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3465, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3466, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3467, + "kind": 32768, + "kindString": "Parameter", + "name": "run_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3468, + "kind": 32768, + "kindString": "Parameter", + "name": "webhooks", + "type": { + "name": "WebhooksList | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "WebhooksList", + "target": "14" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3469, + "kind": 32768, + "kindString": "Parameter", + "name": "force_permission_level", + "type": { + "name": "ActorPermissionLevel | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorPermissionLevel", + "target": "1795" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum time the server waits for the run to finish. If not provided,\nwaits indefinitely." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3470, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_duration", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\ndefault logger will be used. Setting `None` will disable any log propagation. Passing custom logger\nwill redirect logs to the provided logger. The logger is also used to capture status and status message\nof the other Actor run." + } + ] + }, + "defaultValue": "'default'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3471, + "kind": 32768, + "kindString": "Parameter", + "name": "logger", + "type": { + "name": "Logger | None | Literal['default']", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "Logger" + }, + { + "type": "literal", + "value": null + } + ] + }, + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "default" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'no_timeout'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3472, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Run", + "target": "958" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3473, + "module": "_resource_clients.actor", + "name": "build", + "parsedDocstring": { + "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n", + "args": { + "version_number": "Actor version number to be built.", + "beta_packages": "If True, then the Actor is built with beta versions of Apify NPM packages. By default,\nthe build uses latest stable packages.", + "tag": "Tag to be applied to the build on success. By default, the tag is taken from the Actor version's\nbuild tag property.", + "use_cache": "If true, the Actor's Docker container will be rebuilt using layer cache\n(https://docs.docker.com/develop/develop-images/dockerfile_best-practices/`leverage`-build-cache).\nThis is to enable quick rebuild during development. By default, the cache is not used.", + "wait_for_finish": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The build object." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 380 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The build object." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n" + } + ] + }, + "flags": {}, + "id": 3474, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "build", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor version number to be built." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3475, + "kind": 32768, + "kindString": "Parameter", + "name": "version_number", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then the Actor is built with beta versions of Apify NPM packages. By default,\nthe build uses latest stable packages." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3476, + "kind": 32768, + "kindString": "Parameter", + "name": "beta_packages", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tag to be applied to the build on success. By default, the tag is taken from the Actor version's\nbuild tag property." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3477, + "kind": 32768, + "kindString": "Parameter", + "name": "tag", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Actor's Docker container will be rebuilt using layer cache\n(https://docs.docker.com/develop/develop-images/dockerfile_best-practices/`leverage`-build-cache).\nThis is to enable quick rebuild during development. By default, the cache is not used." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3478, + "kind": 32768, + "kindString": "Parameter", + "name": "use_cache", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3479, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_for_finish", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3480, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Build", + "type": "reference", + "target": "306" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the builds of this Actor." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3481, + "module": "_resource_clients.actor", + "name": "builds", + "parsedDocstring": { + "text": "Retrieve a client for the builds of this Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 428 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the builds of this Actor." + } + ] + }, + "flags": {}, + "id": 3482, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "builds", + "parameters": [], + "type": { + "name": "BuildCollectionClient", + "type": "reference", + "target": "2778" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this Actor." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3483, + "module": "_resource_clients.actor", + "name": "runs", + "parsedDocstring": { + "text": "Retrieve a client for the runs of this Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 435 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this Actor." + } + ] + }, + "flags": {}, + "id": 3484, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "runs", + "parameters": [], + "type": { + "name": "RunCollectionClient", + "type": "reference", + "target": "3916" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3485, + "module": "_resource_clients.actor", + "name": "default_build", + "parsedDocstring": { + "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n", + "args": { + "wait_for_finish": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The resource client for the default build of this Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 442 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The resource client for the default build of this Actor." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n" + } + ] + }, + "flags": {}, + "id": 3486, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "default_build", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3487, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_for_finish", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3488, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "BuildClient", + "type": "reference", + "target": "3171" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3489, + "module": "_resource_clients.actor", + "name": "last_run", + "parsedDocstring": { + "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n", + "args": { + "status": "Consider only runs with this status.", + "origin": "Consider only runs started with this origin.\n" + }, + "returns": "The resource client for the last run of this Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 480 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The resource client for the last run of this Actor." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n" + } + ] + }, + "flags": {}, + "id": 3490, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "last_run", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Consider only runs with this status." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3491, + "kind": 32768, + "kindString": "Parameter", + "name": "status", + "type": { + "name": "ActorJobStatus | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorJobStatus", + "target": "1794" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Consider only runs started with this origin.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3492, + "kind": 32768, + "kindString": "Parameter", + "name": "origin", + "type": { + "name": "RunOrigin | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "RunOrigin", + "target": "1799" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "RunClient", + "type": "reference", + "target": "3033" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the versions of this Actor." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3493, + "module": "_resource_clients.actor", + "name": "versions", + "parsedDocstring": { + "text": "Retrieve a client for the versions of this Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 507 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the versions of this Actor." + } + ] + }, + "flags": {}, + "id": 3494, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "versions", + "parameters": [], + "type": { + "name": "ActorVersionCollectionClient", + "type": "reference", + "target": "3275" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified version of this Actor.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3495, + "module": "_resource_clients.actor", + "name": "version", + "parsedDocstring": { + "text": "Retrieve the client for the specified version of this Actor.\n", + "args": { + "version_number": "The version number for which to retrieve the resource client.\n" + }, + "returns": "The resource client for the specified Actor version." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 511 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The resource client for the specified Actor version." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified version of this Actor.\n" + } + ] + }, + "flags": {}, + "id": 3496, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "version", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The version number for which to retrieve the resource client.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3497, + "kind": 32768, + "kindString": "Parameter", + "name": "version_number", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "ActorVersionClient", + "type": "reference", + "target": "2424" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this Actor." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3498, + "module": "_resource_clients.actor", + "name": "webhooks", + "parsedDocstring": { + "text": "Retrieve a client for webhooks associated with this Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 525 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this Actor." + } + ] + }, + "flags": {}, + "id": 3499, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "webhooks", + "parameters": [], + "type": { + "name": "WebhookCollectionClient", + "type": "reference", + "target": "3794" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Validate an input for the Actor that defines an input schema.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3500, + "module": "_resource_clients.actor", + "name": "validate_input", + "parsedDocstring": { + "text": "Validate an input for the Actor that defines an input schema.\n", + "args": { + "run_input": "The input to validate.", + "build_tag": "The Actor's build tag.", + "content_type": "The content type of the input.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "True if the input is valid, else raise an exception with validation error details." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 529 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "True if the input is valid, else raise an exception with validation error details." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Validate an input for the Actor that defines an input schema.\n" + } + ] + }, + "flags": {}, + "id": 3501, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "validate_input", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The input to validate." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 3502, + "kind": 32768, + "kindString": "Parameter", + "name": "run_input", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Actor's build tag." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3503, + "kind": 32768, + "kindString": "Parameter", + "name": "build_tag", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the input." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3504, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3505, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "bool", + "type": "reference" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 4012, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific Actor.\n\nProvides methods to manage a specific Actor, e.g. update it, delete it, build it, or start runs. Obtain an instance\nvia an appropriate method on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3405, + 3473, + 3481, + 3458, + 3485, + 3441, + 3410, + 3489, + 3483, + 3444, + 3413, + 3500, + 3495, + 3493, + 3498 + ], + "title": "Methods" + }, + { + "children": [ + 4012 + ], + "title": "Properties" + } + ], + "id": 3404, + "module": "_resource_clients.actor", + "name": "ActorClient", + "parsedDocstring": { + "text": "Sub-client for managing a specific Actor.\n\nProvides methods to manage a specific Actor, e.g. update it, delete it, build it, or start runs. Obtain an instance\nvia an appropriate method on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 67 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3507, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 570 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3512, + "module": "_resource_clients.actor", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 583 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved Actor." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n" + } + ] + }, + "flags": {}, + "id": 3513, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3514, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Actor | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Actor", + "target": "192" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3515, + "module": "_resource_clients.actor", + "name": "update", + "parsedDocstring": { + "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n", + "args": { + "name": "The name of the Actor.", + "title": "The title of the Actor (human-readable).", + "description": "The description for the Actor.", + "seo_title": "The title of the Actor optimized for search engines.", + "seo_description": "The description of the Actor optimized for search engines.", + "versions": "The list of Actor versions.", + "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.", + "is_public": "Whether the Actor is public.", + "is_deprecated": "Whether the Actor is deprecated.", + "categories": "The categories to which the Actor belongs to.", + "default_run_build": "Tag or number of the build that you want to run by default.", + "default_run_max_items": "Default limit of the number of results that will be returned\nby runs of this Actor, if the Actor is charged per result.", + "default_run_memory_mbytes": "Default amount of memory allocated for the runs of this Actor, in megabytes.", + "default_run_timeout": "Default timeout for the runs of this Actor.", + "example_run_input_body": "Input to be prefilled as default input to new users of this Actor.", + "example_run_input_content_type": "The content type of the example run input.", + "actor_standby_is_enabled": "Whether the Actor Standby is enabled.", + "actor_standby_desired_requests_per_actor_run": "The desired number of concurrent HTTP requests for\na single Actor Standby run.", + "actor_standby_max_requests_per_actor_run": "The maximum number of concurrent HTTP requests for\na single Actor Standby run.", + "actor_standby_idle_timeout": "If the Actor run does not receive any requests for this time,\nit will be shut down.", + "actor_standby_build": "The build tag or number to run when the Actor is in Standby mode.", + "actor_standby_memory_mbytes": "The memory in megabytes to use when the Actor is in Standby mode.", + "pricing_infos": "A list of objects that describes the pricing of the Actor.", + "actor_permission_level": "The permission level of the Actor on Apify platform.", + "tagged_builds": "A dictionary mapping build tag names to their settings. Use it to create, update,\nor remove build tags. To assign a tag, provide a dict with 'buildId' key. To remove a tag,\nset its value to None. Example: {'latest': {'buildId': 'abc'}, 'beta': None}.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 599 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated Actor." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the Actor with the specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/update-actor\n" + } + ] + }, + "flags": {}, + "id": 3516, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3517, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the Actor (human-readable)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3518, + "kind": 32768, + "kindString": "Parameter", + "name": "title", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description for the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3519, + "kind": 32768, + "kindString": "Parameter", + "name": "description", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the Actor optimized for search engines." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3520, + "kind": 32768, + "kindString": "Parameter", + "name": "seo_title", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the Actor optimized for search engines." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3521, + "kind": 32768, + "kindString": "Parameter", + "name": "seo_description", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of Actor versions." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3522, + "kind": 32768, + "kindString": "Parameter", + "name": "versions", + "type": { + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3523, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Actor is public." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3524, + "kind": 32768, + "kindString": "Parameter", + "name": "is_public", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Actor is deprecated." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3525, + "kind": 32768, + "kindString": "Parameter", + "name": "is_deprecated", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The categories to which the Actor belongs to." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3526, + "kind": 32768, + "kindString": "Parameter", + "name": "categories", + "type": { + "name": "list[str] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tag or number of the build that you want to run by default." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3527, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default limit of the number of results that will be returned\nby runs of this Actor, if the Actor is charged per result." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3528, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_max_items", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default amount of memory allocated for the runs of this Actor, in megabytes." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3529, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for the runs of this Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3530, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Input to be prefilled as default input to new users of this Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3531, + "kind": 32768, + "kindString": "Parameter", + "name": "example_run_input_body", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the example run input." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3532, + "kind": 32768, + "kindString": "Parameter", + "name": "example_run_input_content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Actor Standby is enabled." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3533, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_is_enabled", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The desired number of concurrent HTTP requests for\na single Actor Standby run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3534, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_desired_requests_per_actor_run", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of concurrent HTTP requests for\na single Actor Standby run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3535, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_max_requests_per_actor_run", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If the Actor run does not receive any requests for this time,\nit will be shut down." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3536, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_idle_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The build tag or number to run when the Actor is in Standby mode." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3537, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The memory in megabytes to use when the Actor is in Standby mode." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3538, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_standby_memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of objects that describes the pricing of the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3539, + "kind": 32768, + "kindString": "Parameter", + "name": "pricing_infos", + "type": { + "name": "list[dict[str, Any]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The permission level of the Actor on Apify platform." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3540, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_permission_level", + "type": { + "name": "ActorPermissionLevel | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorPermissionLevel", + "target": "1795" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A dictionary mapping build tag names to their settings. Use it to create, update,\nor remove build tags. To assign a tag, provide a dict with 'buildId' key. To remove a tag,\nset its value to None. Example: {'latest': {'buildId': 'abc'}, 'beta': None}." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3541, + "kind": 32768, + "kindString": "Parameter", + "name": "tagged_builds", + "type": { + "name": "dict[str, None | dict[str, str]] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "name": "dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "str" + } + ] + } + ] + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3542, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Actor", + "type": "reference", + "target": "192" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3543, + "module": "_resource_clients.actor", + "name": "delete", + "parsedDocstring": { + "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 707 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor\n" + } + ] + }, + "flags": {}, + "id": 3544, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3545, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3546, + "module": "_resource_clients.actor", + "name": "start", + "parsedDocstring": { + "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n", + "args": { + "run_input": "The input to pass to the Actor run.", + "content_type": "The content type of the input.", + "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest).", + "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit.", + "max_total_charge_usd": "A limit on the total charged amount for pay-per-event Actors.", + "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.", + "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor.", + "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor.", + "force_permission_level": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings.", + "wait_for_finish": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60.", + "webhooks": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The run object." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 717 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The run object." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Start the Actor and immediately return the Run object.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n" + } + ] + }, + "flags": {}, + "id": 3547, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "start", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The input to pass to the Actor run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3548, + "kind": 32768, + "kindString": "Parameter", + "name": "run_input", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the input." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3549, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3550, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3551, + "kind": 32768, + "kindString": "Parameter", + "name": "max_items", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A limit on the total charged amount for pay-per-event Actors." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3552, + "kind": 32768, + "kindString": "Parameter", + "name": "max_total_charge_usd", + "type": { + "name": "Decimal | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Decimal" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3553, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3554, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3555, + "kind": 32768, + "kindString": "Parameter", + "name": "run_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3556, + "kind": 32768, + "kindString": "Parameter", + "name": "force_permission_level", + "type": { + "name": "ActorPermissionLevel | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorPermissionLevel", + "target": "1795" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of seconds the server waits for the run to finish. By default,\nit is 0, the maximum value is 60." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3557, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_for_finish", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks) associated with\nthe Actor run which can be used to receive a notification, e.g. when the Actor finished or failed.\nIf you already have a webhook set up for the Actor or task, you do not have to add it again here.\nEach webhook is represented by a dictionary containing these items:\n* `event_types`: List of `WebhookEventType` values which trigger the webhook.\n* `request_url`: URL to which to send the webhook HTTP request.\n* `payload_template`: Optional template for the request payload." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3558, + "kind": 32768, + "kindString": "Parameter", + "name": "webhooks", + "type": { + "name": "WebhooksList | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "WebhooksList", + "target": "14" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3559, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run", + "type": "reference", + "target": "958" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3560, + "module": "_resource_clients.actor", + "name": "call", + "parsedDocstring": { + "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n", + "args": { + "run_input": "The input to pass to the Actor run.", + "content_type": "The content type of the input.", + "build": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest).", + "max_items": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit.", + "max_total_charge_usd": "A limit on the total charged amount for pay-per-event Actors.", + "restart_on_error": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code.", + "memory_mbytes": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor.", + "run_timeout": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor.", + "force_permission_level": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings.", + "webhooks": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here.", + "wait_duration": "The maximum time the server waits for the run to finish. If not provided,\nwaits indefinitely.", + "logger": "Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\ndefault logger will be used. Setting `None` will disable any log propagation. Passing custom logger\nwill redirect logs to the provided logger. The logger is also used to capture status and status message\nof the other Actor run.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The run object." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 793 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The run object." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Start the Actor and wait for it to finish before returning the Run object.\n\nIt waits indefinitely, unless the wait_duration argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n" + } + ] + }, + "flags": {}, + "id": 3561, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "call", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The input to pass to the Actor run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3562, + "kind": 32768, + "kindString": "Parameter", + "name": "run_input", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the input." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3563, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the Actor build to run. It can be either a build tag or build number. By default,\nthe run uses the build specified in the default run configuration for the Actor (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3564, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of results that will be returned by this run. If the Actor is charged\nper result, you will not be charged for more results than the given limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3565, + "kind": 32768, + "kindString": "Parameter", + "name": "max_items", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A limit on the total charged amount for pay-per-event Actors." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3566, + "kind": 32768, + "kindString": "Parameter", + "name": "max_total_charge_usd", + "type": { + "name": "Decimal | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Decimal" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Actor run process will be restarted whenever it exits with\na non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3567, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes. By default, the run uses a memory limit\nspecified in the default run configuration for the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3568, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run. By default, the run uses timeout specified\nin the default run configuration for the Actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3569, + "kind": 32768, + "kindString": "Parameter", + "name": "run_timeout", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional webhooks (https://docs.apify.com/webhooks) associated with the Actor run, which can\nbe used to receive a notification, e.g. when the Actor finished or failed. If you already have\na webhook set up for the Actor, you do not have to add it again here." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3570, + "kind": 32768, + "kindString": "Parameter", + "name": "webhooks", + "type": { + "name": "WebhooksList | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "WebhooksList", + "target": "14" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Override the Actor's permissions for this run. If not set, the Actor will run\nwith permissions configured in the Actor settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3571, + "kind": 32768, + "kindString": "Parameter", + "name": "force_permission_level", + "type": { + "name": "ActorPermissionLevel | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorPermissionLevel", + "target": "1795" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum time the server waits for the run to finish. If not provided,\nwaits indefinitely." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3572, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_duration", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Logger used to redirect logs from the Actor run. Using \"default\" literal means that a predefined\ndefault logger will be used. Setting `None` will disable any log propagation. Passing custom logger\nwill redirect logs to the provided logger. The logger is also used to capture status and status message\nof the other Actor run." + } + ] + }, + "defaultValue": "'default'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3573, + "kind": 32768, + "kindString": "Parameter", + "name": "logger", + "type": { + "name": "Logger | None | Literal['default']", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "Logger" + }, + { + "type": "literal", + "value": null + } + ] + }, + { + "type": "reference", + "name": "Literal", + "typeArguments": [ + { + "type": "literal", + "value": "default" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'no_timeout'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3574, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Run | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Run", + "target": "958" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3575, + "module": "_resource_clients.actor", + "name": "build", + "parsedDocstring": { + "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n", + "args": { + "version_number": "Actor version number to be built.", + "beta_packages": "If True, then the Actor is built with beta versions of Apify NPM packages. By default,\nthe build uses latest stable packages.", + "tag": "Tag to be applied to the build on success. By default, the tag is taken from the Actor version's\nbuild tag property.", + "use_cache": "If true, the Actor's Docker container will be rebuilt using layer cache\n(https://docs.docker.com/develop/develop-images/dockerfile_best-practices/`leverage`-build-cache).\nThis is to enable quick rebuild during development. By default, the cache is not used.", + "wait_for_finish": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The build object." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 880 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The build object." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Build the Actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/build-collection/build-actor\n" + } + ] + }, + "flags": {}, + "id": 3576, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "build", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor version number to be built." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3577, + "kind": 32768, + "kindString": "Parameter", + "name": "version_number", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then the Actor is built with beta versions of Apify NPM packages. By default,\nthe build uses latest stable packages." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3578, + "kind": 32768, + "kindString": "Parameter", + "name": "beta_packages", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tag to be applied to the build on success. By default, the tag is taken from the Actor version's\nbuild tag property." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3579, + "kind": 32768, + "kindString": "Parameter", + "name": "tag", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the Actor's Docker container will be rebuilt using layer cache\n(https://docs.docker.com/develop/develop-images/dockerfile_best-practices/`leverage`-build-cache).\nThis is to enable quick rebuild during development. By default, the cache is not used." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3580, + "kind": 32768, + "kindString": "Parameter", + "name": "use_cache", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3581, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_for_finish", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3582, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Build", + "type": "reference", + "target": "306" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the builds of this Actor." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3583, + "module": "_resource_clients.actor", + "name": "builds", + "parsedDocstring": { + "text": "Retrieve a client for the builds of this Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 928 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the builds of this Actor." + } + ] + }, + "flags": {}, + "id": 3584, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "builds", + "parameters": [], + "type": { + "name": "BuildCollectionClientAsync", + "type": "reference", + "target": "2795" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this Actor." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3585, + "module": "_resource_clients.actor", + "name": "runs", + "parsedDocstring": { + "text": "Retrieve a client for the runs of this Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 935 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this Actor." + } + ] + }, + "flags": {}, + "id": 3586, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "runs", + "parameters": [], + "type": { + "name": "RunCollectionClientAsync", + "type": "reference", + "target": "3939" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3587, + "module": "_resource_clients.actor", + "name": "default_build", + "parsedDocstring": { + "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n", + "args": { + "wait_for_finish": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The resource client for the default build of this Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 942 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The resource client for the default build of this Actor." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve Actor's default build.\n\nhttps://docs.apify.com/api/v2/act-build-default-get\n" + } + ] + }, + "flags": {}, + "id": 3588, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "default_build", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of seconds the server waits for the build to finish before returning.\nBy default it is 0, the maximum value is 60." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3589, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_for_finish", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3590, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "BuildClientAsync", + "type": "reference", + "target": "3195" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3591, + "module": "_resource_clients.actor", + "name": "last_run", + "parsedDocstring": { + "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n", + "args": { + "status": "Consider only runs with this status.", + "origin": "Consider only runs started with this origin.\n" + }, + "returns": "The resource client for the last run of this Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 980 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The resource client for the last run of this Actor." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the last run of this Actor.\n\nLast run is retrieved based on the start time of the runs.\n" + } + ] + }, + "flags": {}, + "id": 3592, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "last_run", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Consider only runs with this status." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3593, + "kind": 32768, + "kindString": "Parameter", + "name": "status", + "type": { + "name": "ActorJobStatus | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorJobStatus", + "target": "1794" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Consider only runs started with this origin.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3594, + "kind": 32768, + "kindString": "Parameter", + "name": "origin", + "type": { + "name": "RunOrigin | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "RunOrigin", + "target": "1799" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "RunClientAsync", + "type": "reference", + "target": "3102" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the versions of this Actor." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3595, + "module": "_resource_clients.actor", + "name": "versions", + "parsedDocstring": { + "text": "Retrieve a client for the versions of this Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1007 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the versions of this Actor." + } + ] + }, + "flags": {}, + "id": 3596, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "versions", + "parameters": [], + "type": { + "name": "ActorVersionCollectionClientAsync", + "type": "reference", + "target": "3298" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified version of this Actor.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3597, + "module": "_resource_clients.actor", + "name": "version", + "parsedDocstring": { + "text": "Retrieve the client for the specified version of this Actor.\n", + "args": { + "version_number": "The version number for which to retrieve the resource client.\n" + }, + "returns": "The resource client for the specified Actor version." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1011 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The resource client for the specified Actor version." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the client for the specified version of this Actor.\n" + } + ] + }, + "flags": {}, + "id": 3598, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "version", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The version number for which to retrieve the resource client.\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3599, + "kind": 32768, + "kindString": "Parameter", + "name": "version_number", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "ActorVersionClientAsync", + "type": "reference", + "target": "2452" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this Actor." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3600, + "module": "_resource_clients.actor", + "name": "webhooks", + "parsedDocstring": { + "text": "Retrieve a client for webhooks associated with this Actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1025 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this Actor." + } + ] + }, + "flags": {}, + "id": 3601, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "webhooks", + "parameters": [], + "type": { + "name": "WebhookCollectionClientAsync", + "type": "reference", + "target": "3825" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Validate an input for the Actor that defines an input schema.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3602, + "module": "_resource_clients.actor", + "name": "validate_input", + "parsedDocstring": { + "text": "Validate an input for the Actor that defines an input schema.\n", + "args": { + "run_input": "The input to validate.", + "build_tag": "The Actor's build tag.", + "content_type": "The content type of the input.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "True if the input is valid, else raise an exception with validation error details." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 1029 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "True if the input is valid, else raise an exception with validation error details." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Validate an input for the Actor that defines an input schema.\n" + } + ] + }, + "flags": {}, + "id": 3603, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "validate_input", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The input to validate." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 3604, + "kind": 32768, + "kindString": "Parameter", + "name": "run_input", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Actor's build tag." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3605, + "kind": 32768, + "kindString": "Parameter", + "name": "build_tag", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the input." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3606, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3607, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "bool", + "type": "reference" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3985, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific Actor.\n\nProvides methods to manage a specific Actor, e.g. update it, delete it, build it, or start runs. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3507, + 3575, + 3583, + 3560, + 3587, + 3543, + 3512, + 3591, + 3585, + 3546, + 3515, + 3602, + 3597, + 3595, + 3600 + ], + "title": "Methods" + }, + { + "children": [ + 3985 + ], + "title": "Properties" + } + ], + "id": 3506, + "module": "_resource_clients.actor", + "name": "ActorClientAsync", + "parsedDocstring": { + "text": "Sub-client for managing a specific Actor.\n\nProvides methods to manage a specific Actor, e.g. update it, delete it, build it, or start runs. Obtain an instance\nvia an appropriate method on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 563 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3609, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 79 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3614, + "module": "_resource_clients.key_value_store", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved key-value store, or None if it does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 92 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved key-value store, or None if it does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n" + } + ] + }, + "flags": {}, + "id": 3615, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3616, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "KeyValueStore | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "KeyValueStore", + "target": "595" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3617, + "module": "_resource_clients.key_value_store", + "name": "update", + "parsedDocstring": { + "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n", + "args": { + "name": "The new name for key-value store.", + "general_access": "Determines how others can access the key-value store.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated key-value store." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 108 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated key-value store." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n" + } + ] + }, + "flags": {}, + "id": 3618, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new name for key-value store." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3619, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Determines how others can access the key-value store." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3620, + "kind": 32768, + "kindString": "Parameter", + "name": "general_access", + "type": { + "name": "GeneralAccess | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "GeneralAccess", + "target": "1797" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3621, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "KeyValueStore", + "type": "reference", + "target": "595" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3622, + "module": "_resource_clients.key_value_store", + "name": "delete", + "parsedDocstring": { + "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 130 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store\n" + } + ] + }, + "flags": {}, + "id": 3623, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3624, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3625, + "module": "_resource_clients.key_value_store", + "name": "list_keys", + "parsedDocstring": { + "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n", + "args": { + "limit": "Number of keys to be returned. Maximum value is 1000.", + "exclusive_start_key": "All keys up to this one (including) are skipped from the result.", + "collection": "The name of the collection in store schema to list keys from.", + "prefix": "The prefix of the keys to be listed.", + "signature": "Signature used to access the items.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of keys in the key-value store matching the given arguments." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 140 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of keys in the key-value store matching the given arguments." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n" + } + ] + }, + "flags": {}, + "id": 3626, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list_keys", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of keys to be returned. Maximum value is 1000." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3627, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "All keys up to this one (including) are skipped from the result." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3628, + "kind": 32768, + "kindString": "Parameter", + "name": "exclusive_start_key", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the collection in store schema to list keys from." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3629, + "kind": 32768, + "kindString": "Parameter", + "name": "collection", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prefix of the keys to be listed." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3630, + "kind": 32768, + "kindString": "Parameter", + "name": "prefix", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signature used to access the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3631, + "kind": 32768, + "kindString": "Parameter", + "name": "signature", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3632, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfKeys", + "type": "reference", + "target": "667" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the keys in the key-value store.\n\nSimple `list_keys` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3633, + "module": "_resource_clients.key_value_store", + "name": "iterate_keys", + "parsedDocstring": { + "text": "Iterate over the keys in the key-value store.\n\nSimple `list_keys` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n", + "args": { + "limit": "Maximum number of keys to return. By default there is no limit.", + "exclusive_start_key": "All keys up to this one (including) are skipped from the result.", + "collection": "The name of the collection in store schema to list keys from.", + "prefix": "The prefix of the keys to be listed.", + "signature": "Signature used to access the items.", + "chunk_size": "Maximum number of keys requested per API call when iterating across pages.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 183 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the keys in the key-value store.\n\nSimple `list_keys` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n" + } + ] + }, + "flags": {}, + "id": 3634, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate_keys", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of keys to return. By default there is no limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3635, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "All keys up to this one (including) are skipped from the result." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3636, + "kind": 32768, + "kindString": "Parameter", + "name": "exclusive_start_key", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the collection in store schema to list keys from." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3637, + "kind": 32768, + "kindString": "Parameter", + "name": "collection", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prefix of the keys to be listed." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3638, + "kind": 32768, + "kindString": "Parameter", + "name": "prefix", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signature used to access the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3639, + "kind": 32768, + "kindString": "Parameter", + "name": "signature", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of keys requested per API call when iterating across pages." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3640, + "kind": 32768, + "kindString": "Parameter", + "name": "chunk_size", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3641, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "KeyValueStoreKey", + "target": "611" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3642, + "module": "_resource_clients.key_value_store", + "name": "get_record", + "parsedDocstring": { + "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n", + "args": { + "key": "Key of the record to retrieve.", + "signature": "Signature used to access the items.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The requested record, or None, if the record does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 231 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The requested record, or None, if the record does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" + } + ] + }, + "flags": {}, + "id": 3643, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_record", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Key of the record to retrieve." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3644, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signature used to access the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3645, + "kind": 32768, + "kindString": "Parameter", + "name": "signature", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3646, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3647, + "module": "_resource_clients.key_value_store", + "name": "record_exists", + "parsedDocstring": { + "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n", + "args": { + "key": "Key of the record to check.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "True if the record exists, False otherwise." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 263 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "True if the record exists, False otherwise." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n" + } + ] + }, + "flags": {}, + "id": 3648, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "record_exists", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Key of the record to check." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3649, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3650, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "bool", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3651, + "module": "_resource_clients.key_value_store", + "name": "get_record_as_bytes", + "parsedDocstring": { + "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n", + "args": { + "key": "Key of the record to retrieve.", + "signature": "Signature used to access the items.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The requested record, or None, if the record does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 290 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The requested record, or None, if the record does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" + } + ] + }, + "flags": {}, + "id": 3652, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_record_as_bytes", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Key of the record to retrieve." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3653, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signature used to access the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3654, + "kind": 32768, + "kindString": "Parameter", + "name": "signature", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3655, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" + } + ] + }, + "decorations": [ + { + "name": "contextmanager" + } + ], + "flags": {}, + "groups": [], + "id": 3656, + "module": "_resource_clients.key_value_store", + "name": "stream_record", + "parsedDocstring": { + "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n", + "args": { + "key": "Key of the record to retrieve.", + "signature": "Signature used to access the items.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The requested record as a context-managed streaming Response, or None, if the record does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 323 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The requested record as a context-managed streaming Response, or None, if the record does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" + } + ] + }, + "flags": {}, + "id": 3657, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "stream_record", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Key of the record to retrieve." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3658, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signature used to access the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3659, + "kind": 32768, + "kindString": "Parameter", + "name": "signature", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3660, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3661, + "module": "_resource_clients.key_value_store", + "name": "set_record", + "parsedDocstring": { + "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n", + "args": { + "key": "The key of the record to save the value to.", + "value": "The value to save into the record.", + "content_type": "The content type of the saved value.", + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 361 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n" + } + ] + }, + "flags": {}, + "id": 3662, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "set_record", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The key of the record to save the value to." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3663, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value to save into the record." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3664, + "kind": 32768, + "kindString": "Parameter", + "name": "value", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the saved value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3665, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3666, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3667, + "module": "_resource_clients.key_value_store", + "name": "delete_record", + "parsedDocstring": { + "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n", + "args": { + "key": "The key of the record which to delete.", + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 392 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n" + } + ] + }, + "flags": {}, + "id": 3668, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete_record", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The key of the record which to delete." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3669, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3670, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3671, + "module": "_resource_clients.key_value_store", + "name": "get_record_public_url", + "parsedDocstring": { + "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n", + "args": { + "key": "The key for which the URL should be generated.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "A public URL that can be used to access the value of the given key in the KVS." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 408 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A public URL that can be used to access the value of the given key in the KVS." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n" + } + ] + }, + "flags": {}, + "id": 3672, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_record_public_url", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The key for which the URL should be generated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3673, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3674, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3675, + "module": "_resource_clients.key_value_store", + "name": "create_keys_public_url", + "parsedDocstring": { + "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n", + "args": { + "limit": "Number of keys to be returned. Maximum value is 1000.", + "exclusive_start_key": "All keys up to this one (including) are skipped from the result.", + "collection": "The name of the collection in store schema to list keys from.", + "prefix": "The prefix of the keys to be listed.", + "expires_in": "How long the signed URL should be valid from the time it is generated.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The public key-value store keys URL." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 439 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The public key-value store keys URL." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n" + } + ] + }, + "flags": {}, + "id": 3676, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "create_keys_public_url", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of keys to be returned. Maximum value is 1000." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3677, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "All keys up to this one (including) are skipped from the result." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3678, + "kind": 32768, + "kindString": "Parameter", + "name": "exclusive_start_key", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the collection in store schema to list keys from." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3679, + "kind": 32768, + "kindString": "Parameter", + "name": "collection", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prefix of the keys to be listed." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3680, + "kind": 32768, + "kindString": "Parameter", + "name": "prefix", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How long the signed URL should be valid from the time it is generated." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3681, + "kind": 32768, + "kindString": "Parameter", + "name": "expires_in", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3682, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 4013, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific key-value store.\n\nProvides methods to manage a specific key-value store, e.g. get it, update it, or manage its records. Obtain an\ninstance via an appropriate method on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3609, + 3675, + 3622, + 3667, + 3614, + 3642, + 3651, + 3671, + 3633, + 3625, + 3647, + 3661, + 3656, + 3617 + ], + "title": "Methods" + }, + { + "children": [ + 4013 + ], + "title": "Properties" + } + ], + "id": 3608, + "module": "_resource_clients.key_value_store", + "name": "KeyValueStoreClient", + "parsedDocstring": { + "text": "Sub-client for managing a specific key-value store.\n\nProvides methods to manage a specific key-value store, e.g. get it, update it, or manage its records. Obtain an\ninstance via an appropriate method on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3684, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 505 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3689, + "module": "_resource_clients.key_value_store", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved key-value store, or None if it does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 518 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved key-value store, or None if it does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store\n" + } + ] + }, + "flags": {}, + "id": 3690, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3691, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "KeyValueStore | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "KeyValueStore", + "target": "595" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3692, + "module": "_resource_clients.key_value_store", + "name": "update", + "parsedDocstring": { + "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n", + "args": { + "name": "The new name for key-value store.", + "general_access": "Determines how others can access the key-value store.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated key-value store." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 534 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated key-value store." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the key-value store with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store\n" + } + ] + }, + "flags": {}, + "id": 3693, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new name for key-value store." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3694, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Determines how others can access the key-value store." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3695, + "kind": 32768, + "kindString": "Parameter", + "name": "general_access", + "type": { + "name": "GeneralAccess | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "GeneralAccess", + "target": "1797" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3696, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "KeyValueStore", + "type": "reference", + "target": "595" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3697, + "module": "_resource_clients.key_value_store", + "name": "delete", + "parsedDocstring": { + "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 556 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store\n" + } + ] + }, + "flags": {}, + "id": 3698, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3699, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3700, + "module": "_resource_clients.key_value_store", + "name": "list_keys", + "parsedDocstring": { + "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n", + "args": { + "limit": "Number of keys to be returned. Maximum value is 1000.", + "exclusive_start_key": "All keys up to this one (including) are skipped from the result.", + "collection": "The name of the collection in store schema to list keys from.", + "prefix": "The prefix of the keys to be listed.", + "signature": "Signature used to access the items.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of keys in the key-value store matching the given arguments." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 566 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of keys in the key-value store matching the given arguments." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the keys in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n" + } + ] + }, + "flags": {}, + "id": 3701, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "list_keys", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of keys to be returned. Maximum value is 1000." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3702, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "All keys up to this one (including) are skipped from the result." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3703, + "kind": 32768, + "kindString": "Parameter", + "name": "exclusive_start_key", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the collection in store schema to list keys from." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3704, + "kind": 32768, + "kindString": "Parameter", + "name": "collection", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prefix of the keys to be listed." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3705, + "kind": 32768, + "kindString": "Parameter", + "name": "prefix", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signature used to access the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3706, + "kind": 32768, + "kindString": "Parameter", + "name": "signature", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3707, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfKeys", + "type": "reference", + "target": "667" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the keys in the key-value store.\n\nSimple `list_keys` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3708, + "module": "_resource_clients.key_value_store", + "name": "iterate_keys", + "parsedDocstring": { + "text": "Iterate over the keys in the key-value store.\n\nSimple `list_keys` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n", + "args": { + "limit": "Maximum number of keys to return. By default there is no limit.", + "exclusive_start_key": "All keys up to this one (including) are skipped from the result.", + "collection": "The name of the collection in store schema to list keys from.", + "prefix": "The prefix of the keys to be listed.", + "signature": "Signature used to access the items.", + "chunk_size": "Maximum number of keys requested per API call when iterating across pages.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 609 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the keys in the key-value store.\n\nSimple `list_keys` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys\n" + } + ] + }, + "flags": {}, + "id": 3709, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate_keys", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of keys to return. By default there is no limit." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3710, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "All keys up to this one (including) are skipped from the result." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3711, + "kind": 32768, + "kindString": "Parameter", + "name": "exclusive_start_key", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the collection in store schema to list keys from." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3712, + "kind": 32768, + "kindString": "Parameter", + "name": "collection", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prefix of the keys to be listed." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3713, + "kind": 32768, + "kindString": "Parameter", + "name": "prefix", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signature used to access the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3714, + "kind": 32768, + "kindString": "Parameter", + "name": "signature", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of keys requested per API call when iterating across pages." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3715, + "kind": 32768, + "kindString": "Parameter", + "name": "chunk_size", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3716, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "KeyValueStoreKey", + "target": "611" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3717, + "module": "_resource_clients.key_value_store", + "name": "get_record", + "parsedDocstring": { + "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n", + "args": { + "key": "Key of the record to retrieve.", + "signature": "Signature used to access the items.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The requested record, or None, if the record does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 657 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The requested record, or None, if the record does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" + } + ] + }, + "flags": {}, + "id": 3718, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_record", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Key of the record to retrieve." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3719, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signature used to access the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3720, + "kind": 32768, + "kindString": "Parameter", + "name": "signature", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3721, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3722, + "module": "_resource_clients.key_value_store", + "name": "record_exists", + "parsedDocstring": { + "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n", + "args": { + "key": "Key of the record to check.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "True if the record exists, False otherwise." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 689 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "True if the record exists, False otherwise." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Check if given record is present in the key-value store.\n\nhttps://docs.apify.com/api/v2/key-value-store-record-head\n" + } + ] + }, + "flags": {}, + "id": 3723, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "record_exists", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Key of the record to check." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3724, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3725, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "bool", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3726, + "module": "_resource_clients.key_value_store", + "name": "get_record_as_bytes", + "parsedDocstring": { + "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n", + "args": { + "key": "Key of the record to retrieve.", + "signature": "Signature used to access the items.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The requested record, or None, if the record does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 716 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The requested record, or None, if the record does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, without parsing it.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" + } + ] + }, + "flags": {}, + "id": 3727, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_record_as_bytes", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Key of the record to retrieve." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3728, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signature used to access the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3729, + "kind": 32768, + "kindString": "Parameter", + "name": "signature", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3730, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" + } + ] + }, + "decorations": [ + { + "name": "asynccontextmanager" + } + ], + "flags": {}, + "groups": [], + "id": 3731, + "module": "_resource_clients.key_value_store", + "name": "stream_record", + "parsedDocstring": { + "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n", + "args": { + "key": "Key of the record to retrieve.", + "signature": "Signature used to access the items.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The requested record as a context-managed streaming Response, or None, if the record does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 751 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The requested record as a context-managed streaming Response, or None, if the record does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the given record from the key-value store, as a stream.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record\n" + } + ] + }, + "flags": {}, + "id": 3732, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "stream_record", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Key of the record to retrieve." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3733, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Signature used to access the items." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3734, + "kind": 32768, + "kindString": "Parameter", + "name": "signature", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3735, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3736, + "module": "_resource_clients.key_value_store", + "name": "set_record", + "parsedDocstring": { + "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n", + "args": { + "key": "The key of the record to save the value to.", + "value": "The value to save into the record.", + "content_type": "The content type of the saved value.", + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 789 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set a value to the given record in the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record\n" + } + ] + }, + "flags": {}, + "id": 3737, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "set_record", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The key of the record to save the value to." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3738, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value to save into the record." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3739, + "kind": 32768, + "kindString": "Parameter", + "name": "value", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the saved value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3740, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3741, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3742, + "module": "_resource_clients.key_value_store", + "name": "delete_record", + "parsedDocstring": { + "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n", + "args": { + "key": "The key of the record which to delete.", + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 820 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the specified record from the key-value store.\n\nhttps://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record\n" + } + ] + }, + "flags": {}, + "id": 3743, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "delete_record", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The key of the record which to delete." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3744, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3745, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3746, + "module": "_resource_clients.key_value_store", + "name": "get_record_public_url", + "parsedDocstring": { + "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n", + "args": { + "key": "The key for which the URL should be generated.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "A public URL that can be used to access the value of the given key in the KVS." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 836 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A public URL that can be used to access the value of the given key in the KVS." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store record.\n\nIf the client has permission to access the key-value store's URL signing key, the URL will include a signature\nto verify its authenticity.\n" + } + ] + }, + "flags": {}, + "id": 3747, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get_record_public_url", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The key for which the URL should be generated." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 3748, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3749, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3750, + "module": "_resource_clients.key_value_store", + "name": "create_keys_public_url", + "parsedDocstring": { + "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n", + "args": { + "limit": "Number of keys to be returned. Maximum value is 1000.", + "exclusive_start_key": "All keys up to this one (including) are skipped from the result.", + "collection": "The name of the collection in store schema to list keys from.", + "prefix": "The prefix of the keys to be listed.", + "expires_in": "How long the signed URL should be valid from the time it is generated.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The public key-value store keys URL." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 867 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The public key-value store keys URL." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Generate a URL that can be used to access key-value store keys.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a signature to verify its authenticity.\n\nYou can optionally control how long the signed URL should be valid using the `expires_in` option.\nThis value sets the expiration duration from the time the URL is generated.\nIf not provided, the URL will not expire.\n\nAny other options (like `limit` or `prefix`) will be included as query parameters in the URL.\n" + } + ] + }, + "flags": {}, + "id": 3751, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "create_keys_public_url", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number of keys to be returned. Maximum value is 1000." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3752, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "All keys up to this one (including) are skipped from the result." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3753, + "kind": 32768, + "kindString": "Parameter", + "name": "exclusive_start_key", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the collection in store schema to list keys from." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3754, + "kind": 32768, + "kindString": "Parameter", + "name": "collection", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prefix of the keys to be listed." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3755, + "kind": 32768, + "kindString": "Parameter", + "name": "prefix", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How long the signed URL should be valid from the time it is generated." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3756, + "kind": 32768, + "kindString": "Parameter", + "name": "expires_in", + "type": { + "name": "timedelta | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "timedelta" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'long'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3757, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "str", + "type": "reference" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3986, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific key-value store.\n\nProvides methods to manage a specific key-value store, e.g. get it, update it, or manage its records. Obtain an\ninstance via an appropriate method on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3684, + 3750, + 3697, + 3742, + 3689, + 3717, + 3726, + 3746, + 3708, + 3700, + 3722, + 3736, + 3731, + 3692 + ], + "title": "Methods" + }, + { + "children": [ + 3986 + ], + "title": "Properties" + } + ], + "id": 3683, + "module": "_resource_clients.key_value_store", + "name": "KeyValueStoreClientAsync", + "parsedDocstring": { + "text": "Sub-client for managing a specific key-value store.\n\nProvides methods to manage a specific key-value store, e.g. get it, update it, or manage its records. Obtain an\ninstance via an appropriate method on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/key_value_store.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 498 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3759, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 21 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3764, + "module": "_resource_clients.actor_env_var", + "name": "get", + "parsedDocstring": { + "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved Actor environment variable data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 34 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved Actor environment variable data." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n" + } + ] + }, + "flags": {}, + "id": 3765, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3766, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "EnvVar | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "EnvVar", + "target": "541" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3767, + "module": "_resource_clients.actor_env_var", + "name": "update", + "parsedDocstring": { + "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n", + "args": { + "is_secret": "Whether the environment variable is secret or not.", + "name": "The name of the environment variable.", + "value": "The value of the environment variable.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated Actor environment variable." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 50 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated Actor environment variable." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n" + } + ] + }, + "flags": {}, + "id": 3768, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the environment variable is secret or not." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3769, + "kind": 32768, + "kindString": "Parameter", + "name": "is_secret", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the environment variable." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3770, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the environment variable." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3771, + "kind": 32768, + "kindString": "Parameter", + "name": "value", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3772, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "EnvVar", + "type": "reference", + "target": "541" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3773, + "module": "_resource_clients.actor_env_var", + "name": "delete", + "parsedDocstring": { + "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 77 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable\n" + } + ] + }, + "flags": {}, + "id": 3774, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3775, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 4014, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific Actor environment variable.\n\nProvides methods to manage a specific Actor environment variable, e.g. get, update, or delete it. Obtain an instance\nvia an appropriate method on the `ActorVersionClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3759, + 3773, + 3764, + 3767 + ], + "title": "Methods" + }, + { + "children": [ + 4014 + ], + "title": "Properties" + } + ], + "id": 3758, + "module": "_resource_clients.actor_env_var", + "name": "ActorEnvVarClient", + "parsedDocstring": { + "text": "Sub-client for managing a specific Actor environment variable.\n\nProvides methods to manage a specific Actor environment variable, e.g. get, update, or delete it. Obtain an instance\nvia an appropriate method on the `ActorVersionClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 14 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3777, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 96 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3782, + "module": "_resource_clients.actor_env_var", + "name": "get", + "parsedDocstring": { + "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved Actor environment variable data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 109 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved Actor environment variable data." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Return information about the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/get-environment-variable\n" + } + ] + }, + "flags": {}, + "id": 3783, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3784, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "EnvVar | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "EnvVar", + "target": "541" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3785, + "module": "_resource_clients.actor_env_var", + "name": "update", + "parsedDocstring": { + "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n", + "args": { + "is_secret": "Whether the environment variable is secret or not.", + "name": "The name of the environment variable.", + "value": "The value of the environment variable.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated Actor environment variable." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 125 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated Actor environment variable." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the Actor environment variable with specified fields.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/update-environment-variable\n" + } + ] + }, + "flags": {}, + "id": 3786, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the environment variable is secret or not." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3787, + "kind": 32768, + "kindString": "Parameter", + "name": "is_secret", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the environment variable." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3788, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the environment variable." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3789, + "kind": 32768, + "kindString": "Parameter", + "name": "value", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3790, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "EnvVar", + "type": "reference", + "target": "541" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3791, + "module": "_resource_clients.actor_env_var", + "name": "delete", + "parsedDocstring": { + "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 152 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the Actor environment variable.\n\nhttps://docs.apify.com/api/v2#/reference/actors/environment-variable-object/delete-environment-variable\n" + } + ] + }, + "flags": {}, + "id": 3792, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3793, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3987, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific Actor environment variable.\n\nProvides methods to manage a specific Actor environment variable, e.g. get, update, or delete it. Obtain an instance\nvia an appropriate method on the `ActorVersionClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3777, + 3791, + 3782, + 3785 + ], + "title": "Methods" + }, + { + "children": [ + 3987 + ], + "title": "Properties" + } + ], + "id": 3776, + "module": "_resource_clients.actor_env_var", + "name": "ActorEnvVarClientAsync", + "parsedDocstring": { + "text": "Sub-client for managing a specific Actor environment variable.\n\nProvides methods to manage a specific Actor environment variable, e.g. get, update, or delete it. Obtain an instance\nvia an appropriate method on the `ActorVersionClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/actor_env_var.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 89 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3795, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 32 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3799, + "module": "_resource_clients.webhook_collection", + "name": "list", + "parsedDocstring": { + "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n", + "args": { + "limit": "How many webhooks to retrieve.", + "offset": "What webhook to include as first when retrieving the list.", + "desc": "Whether to sort the webhooks in descending order based on their date of creation.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available webhooks matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 43 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available webhooks matching the specified filters." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n" + } + ] + }, + "flags": {}, + "id": 3800, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many webhooks to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3801, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What webhook to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3802, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the webhooks in descending order based on their date of creation." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3803, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3804, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfWebhooks", + "type": "reference", + "target": "783" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available webhooks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3805, + "module": "_resource_clients.webhook_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over the available webhooks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n", + "args": { + "limit": "How many webhooks to retrieve.", + "offset": "What webhook to include as first when retrieving the list.", + "desc": "Whether to sort the webhooks in descending order based on their date of creation.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 67 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available webhooks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n" + } + ] + }, + "flags": {}, + "id": 3806, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many webhooks to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3807, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What webhook to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3808, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the webhooks in descending order based on their date of creation." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3809, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3810, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookShort", + "target": "1406" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3811, + "module": "_resource_clients.webhook_collection", + "name": "create", + "parsedDocstring": { + "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n", + "args": { + "event_types": "List of event types that should trigger the webhook. At least one is required.", + "request_url": "URL that will be invoked once the webhook is triggered.", + "payload_template": "Specification of the payload that will be sent to request_url.", + "headers_template": "Headers that will be sent to the request_url.", + "actor_id": "Id of the Actor whose runs should trigger the webhook.", + "actor_task_id": "Id of the Actor task whose runs should trigger the webhook.", + "actor_run_id": "Id of the Actor run which should trigger the webhook.", + "ignore_ssl_errors": "Whether the webhook should ignore SSL errors returned by request_url.", + "do_not_retry": "Whether the webhook should retry sending the payload to request_url upon failure.", + "idempotency_key": "A unique identifier of a webhook. You can use it to ensure that you won't create\nthe same webhook multiple times.", + "is_ad_hoc": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The created webhook." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 97 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The created webhook." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n" + } + ] + }, + "flags": {}, + "id": 3812, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "create", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of event types that should trigger the webhook. At least one is required." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3813, + "kind": 32768, + "kindString": "Parameter", + "name": "event_types", + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookEventType", + "target": "1804" + } + ], + "target": "2199" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "URL that will be invoked once the webhook is triggered." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3814, + "kind": 32768, + "kindString": "Parameter", + "name": "request_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specification of the payload that will be sent to request_url." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3815, + "kind": 32768, + "kindString": "Parameter", + "name": "payload_template", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers that will be sent to the request_url." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3816, + "kind": 32768, + "kindString": "Parameter", + "name": "headers_template", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Id of the Actor whose runs should trigger the webhook." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3817, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Id of the Actor task whose runs should trigger the webhook." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3818, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_task_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Id of the Actor run which should trigger the webhook." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3819, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_run_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the webhook should ignore SSL errors returned by request_url." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3820, + "kind": 32768, + "kindString": "Parameter", + "name": "ignore_ssl_errors", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the webhook should retry sending the payload to request_url upon failure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3821, + "kind": 32768, + "kindString": "Parameter", + "name": "do_not_retry", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier of a webhook. You can use it to ensure that you won't create\nthe same webhook multiple times." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3822, + "kind": 32768, + "kindString": "Parameter", + "name": "idempotency_key", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3823, + "kind": 32768, + "kindString": "Parameter", + "name": "is_ad_hoc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3824, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Webhook", + "type": "reference", + "target": "1350" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 4015, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the webhook collection.\n\nProvides methods to manage the webhook collection, e.g. list or create webhooks. Obtain an instance via an\nappropriate method on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3795, + 3811, + 3805, + 3799 + ], + "title": "Methods" + }, + { + "children": [ + 4015 + ], + "title": "Properties" + } + ], + "id": 3794, + "module": "_resource_clients.webhook_collection", + "name": "WebhookCollectionClient", + "parsedDocstring": { + "text": "Sub-client for the webhook collection.\n\nProvides methods to manage the webhook collection, e.g. list or create webhooks. Obtain an instance via an\nappropriate method on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 25 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3826, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 165 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3830, + "module": "_resource_clients.webhook_collection", + "name": "list", + "parsedDocstring": { + "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n", + "args": { + "limit": "How many webhooks to retrieve.", + "offset": "What webhook to include as first when retrieving the list.", + "desc": "Whether to sort the webhooks in descending order based on their date of creation.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The list of available webhooks matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 176 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The list of available webhooks matching the specified filters." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List the available webhooks.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n" + } + ] + }, + "flags": {}, + "id": 3831, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many webhooks to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3832, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What webhook to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3833, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the webhooks in descending order based on their date of creation." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3834, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3835, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfWebhooks", + "type": "reference", + "target": "783" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available webhooks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3836, + "module": "_resource_clients.webhook_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over the available webhooks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n", + "args": { + "limit": "How many webhooks to retrieve.", + "offset": "What webhook to include as first when retrieving the list.", + "desc": "Whether to sort the webhooks in descending order based on their date of creation.", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 200 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over the available webhooks.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks\n" + } + ] + }, + "flags": {}, + "id": 3837, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many webhooks to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3838, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What webhook to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3839, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the webhooks in descending order based on their date of creation." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3840, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3841, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookShort", + "target": "1406" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3842, + "module": "_resource_clients.webhook_collection", + "name": "create", + "parsedDocstring": { + "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n", + "args": { + "event_types": "List of event types that should trigger the webhook. At least one is required.", + "request_url": "URL that will be invoked once the webhook is triggered.", + "payload_template": "Specification of the payload that will be sent to request_url.", + "headers_template": "Headers that will be sent to the request_url.", + "actor_id": "Id of the Actor whose runs should trigger the webhook.", + "actor_task_id": "Id of the Actor task whose runs should trigger the webhook.", + "actor_run_id": "Id of the Actor run which should trigger the webhook.", + "ignore_ssl_errors": "Whether the webhook should ignore SSL errors returned by request_url.", + "do_not_retry": "Whether the webhook should retry sending the payload to request_url upon failure.", + "idempotency_key": "A unique identifier of a webhook. You can use it to ensure that you won't create\nthe same webhook multiple times.", + "is_ad_hoc": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The created webhook." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 230 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The created webhook." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Create a new webhook.\n\nYou have to specify exactly one out of actor_id, actor_task_id or actor_run_id.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook\n" + } + ] + }, + "flags": {}, + "id": 3843, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "create", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of event types that should trigger the webhook. At least one is required." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3844, + "kind": 32768, + "kindString": "Parameter", + "name": "event_types", + "type": { + "name": "list", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookEventType", + "target": "1804" + } + ], + "target": "2199" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "URL that will be invoked once the webhook is triggered." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3845, + "kind": 32768, + "kindString": "Parameter", + "name": "request_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specification of the payload that will be sent to request_url." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3846, + "kind": 32768, + "kindString": "Parameter", + "name": "payload_template", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers that will be sent to the request_url." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3847, + "kind": 32768, + "kindString": "Parameter", + "name": "headers_template", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Id of the Actor whose runs should trigger the webhook." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3848, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Id of the Actor task whose runs should trigger the webhook." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3849, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_task_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Id of the Actor run which should trigger the webhook." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3850, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_run_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the webhook should ignore SSL errors returned by request_url." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3851, + "kind": 32768, + "kindString": "Parameter", + "name": "ignore_ssl_errors", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the webhook should retry sending the payload to request_url upon failure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3852, + "kind": 32768, + "kindString": "Parameter", + "name": "do_not_retry", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier of a webhook. You can use it to ensure that you won't create\nthe same webhook multiple times." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3853, + "kind": 32768, + "kindString": "Parameter", + "name": "idempotency_key", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3854, + "kind": 32768, + "kindString": "Parameter", + "name": "is_ad_hoc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3855, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Webhook", + "type": "reference", + "target": "1350" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3988, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the webhook collection.\n\nProvides methods to manage the webhook collection, e.g. list or create webhooks. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3826, + 3842, + 3836, + 3830 + ], + "title": "Methods" + }, + { + "children": [ + 3988 + ], + "title": "Properties" + } + ], + "id": 3825, + "module": "_resource_clients.webhook_collection", + "name": "WebhookCollectionClientAsync", + "parsedDocstring": { + "text": "Sub-client for the webhook collection.\n\nProvides methods to manage the webhook collection, e.g. list or create webhooks. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 158 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3857, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 33 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3862, + "module": "_resource_clients.webhook", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved webhook, or None if it does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 46 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved webhook, or None if it does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n" + } + ] + }, + "flags": {}, + "id": 3863, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3864, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Webhook | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Webhook", + "target": "1350" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3865, + "module": "_resource_clients.webhook", + "name": "update", + "parsedDocstring": { + "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n", + "args": { + "event_types": "List of event types that should trigger the webhook. At least one is required.", + "request_url": "URL that will be invoked once the webhook is triggered.", + "payload_template": "Specification of the payload that will be sent to request_url.", + "headers_template": "Headers that will be sent to the request_url.", + "actor_id": "Id of the Actor whose runs should trigger the webhook.", + "actor_task_id": "Id of the Actor task whose runs should trigger the webhook.", + "actor_run_id": "Id of the Actor run which should trigger the webhook.", + "ignore_ssl_errors": "Whether the webhook should ignore SSL errors returned by request_url.", + "do_not_retry": "Whether the webhook should retry sending the payload to request_url upon failure.", + "is_ad_hoc": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated webhook." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 62 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated webhook." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n" + } + ] + }, + "flags": {}, + "id": 3866, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of event types that should trigger the webhook. At least one is required." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3867, + "kind": 32768, + "kindString": "Parameter", + "name": "event_types", + "type": { + "name": "list[WebhookEventType] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookEventType", + "target": "1804" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "URL that will be invoked once the webhook is triggered." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3868, + "kind": 32768, + "kindString": "Parameter", + "name": "request_url", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specification of the payload that will be sent to request_url." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3869, + "kind": 32768, + "kindString": "Parameter", + "name": "payload_template", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers that will be sent to the request_url." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3870, + "kind": 32768, + "kindString": "Parameter", + "name": "headers_template", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Id of the Actor whose runs should trigger the webhook." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3871, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Id of the Actor task whose runs should trigger the webhook." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3872, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_task_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Id of the Actor run which should trigger the webhook." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3873, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_run_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the webhook should ignore SSL errors returned by request_url." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3874, + "kind": 32768, + "kindString": "Parameter", + "name": "ignore_ssl_errors", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the webhook should retry sending the payload to request_url upon failure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3875, + "kind": 32768, + "kindString": "Parameter", + "name": "do_not_retry", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3876, + "kind": 32768, + "kindString": "Parameter", + "name": "is_ad_hoc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3877, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Webhook", + "type": "reference", + "target": "1350" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3878, + "module": "_resource_clients.webhook", + "name": "delete", + "parsedDocstring": { + "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 115 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook\n" + } + ] + }, + "flags": {}, + "id": 3879, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3880, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3881, + "module": "_resource_clients.webhook", + "name": "test", + "parsedDocstring": { + "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The webhook dispatch created by the test." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 125 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The webhook dispatch created by the test." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n" + } + ] + }, + "flags": {}, + "id": 3882, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "test", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3883, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "WebhookDispatch", + "type": "reference", + "target": "1386" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3884, + "module": "_resource_clients.webhook", + "name": "dispatches", + "parsedDocstring": { + "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n", + "returns": "A client allowing access to dispatches of this webhook using its list method." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 151 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A client allowing access to dispatches of this webhook using its list method." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n" + } + ] + }, + "flags": {}, + "id": 3885, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "dispatches", + "parameters": [], + "type": { + "name": "WebhookDispatchCollectionClient", + "type": "reference", + "target": "2228" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 4016, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific webhook.\n\nProvides methods to manage a specific webhook, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3857, + 3878, + 3884, + 3862, + 3881, + 3865 + ], + "title": "Methods" + }, + { + "children": [ + 4016 + ], + "title": "Properties" + } + ], + "id": 3856, + "module": "_resource_clients.webhook", + "name": "WebhookClient", + "parsedDocstring": { + "text": "Sub-client for managing a specific webhook.\n\nProvides methods to manage a specific webhook, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 26 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3887, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 173 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3892, + "module": "_resource_clients.webhook", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved webhook, or None if it does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 186 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved webhook, or None if it does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n" + } + ] + }, + "flags": {}, + "id": 3893, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "get", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3894, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Webhook | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "Webhook", + "target": "1350" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3895, + "module": "_resource_clients.webhook", + "name": "update", + "parsedDocstring": { + "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n", + "args": { + "event_types": "List of event types that should trigger the webhook. At least one is required.", + "request_url": "URL that will be invoked once the webhook is triggered.", + "payload_template": "Specification of the payload that will be sent to request_url.", + "headers_template": "Headers that will be sent to the request_url.", + "actor_id": "Id of the Actor whose runs should trigger the webhook.", + "actor_task_id": "Id of the Actor task whose runs should trigger the webhook.", + "actor_run_id": "Id of the Actor run which should trigger the webhook.", + "ignore_ssl_errors": "Whether the webhook should ignore SSL errors returned by request_url.", + "do_not_retry": "Whether the webhook should retry sending the payload to request_url upon failure.", + "is_ad_hoc": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled.", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The updated webhook." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 202 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The updated webhook." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Update the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook\n" + } + ] + }, + "flags": {}, + "id": 3896, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of event types that should trigger the webhook. At least one is required." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3897, + "kind": 32768, + "kindString": "Parameter", + "name": "event_types", + "type": { + "name": "list[WebhookEventType] | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookEventType", + "target": "1804" + } + ], + "target": "2199" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "URL that will be invoked once the webhook is triggered." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3898, + "kind": 32768, + "kindString": "Parameter", + "name": "request_url", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specification of the payload that will be sent to request_url." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3899, + "kind": 32768, + "kindString": "Parameter", + "name": "payload_template", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Headers that will be sent to the request_url." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3900, + "kind": 32768, + "kindString": "Parameter", + "name": "headers_template", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Id of the Actor whose runs should trigger the webhook." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3901, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Id of the Actor task whose runs should trigger the webhook." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3902, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_task_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Id of the Actor run which should trigger the webhook." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3903, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_run_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the webhook should ignore SSL errors returned by request_url." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3904, + "kind": 32768, + "kindString": "Parameter", + "name": "ignore_ssl_errors", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the webhook should retry sending the payload to request_url upon failure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3905, + "kind": 32768, + "kindString": "Parameter", + "name": "do_not_retry", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set to True if you want the webhook to be triggered only the first time the condition\nis fulfilled. Only applicable when actor_run_id is filled." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3906, + "kind": 32768, + "kindString": "Parameter", + "name": "is_ad_hoc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3907, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Webhook", + "type": "reference", + "target": "1350" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3908, + "module": "_resource_clients.webhook", + "name": "delete", + "parsedDocstring": { + "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook\n", + "args": { + "timeout": "Timeout for the API HTTP request." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 255 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook\n" + } + ] + }, + "flags": {}, + "id": 3909, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "delete", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request." + } + ] + }, + "defaultValue": "'short'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3910, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3911, + "module": "_resource_clients.webhook", + "name": "test", + "parsedDocstring": { + "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n", + "args": { + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The webhook dispatch created by the test." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 265 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The webhook dispatch created by the test." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Test a webhook.\n\nCreates a webhook dispatch with a dummy payload.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook\n" + } + ] + }, + "flags": {}, + "id": 3912, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "test", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3913, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "WebhookDispatch", + "type": "reference", + "target": "1386" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3914, + "module": "_resource_clients.webhook", + "name": "dispatches", + "parsedDocstring": { + "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n", + "returns": "A client allowing access to dispatches of this webhook using its list method." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 291 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "A client allowing access to dispatches of this webhook using its list method." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Get dispatches of the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection\n" + } + ] + }, + "flags": {}, + "id": 3915, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "dispatches", + "parameters": [], + "type": { + "name": "WebhookDispatchCollectionClientAsync", + "type": "reference", + "target": "2245" + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3989, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for managing a specific webhook.\n\nProvides methods to manage a specific webhook, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3887, + 3908, + 3914, + 3892, + 3911, + 3895 + ], + "title": "Methods" + }, + { + "children": [ + 3989 + ], + "title": "Properties" + } + ], + "id": 3886, + "module": "_resource_clients.webhook", + "name": "WebhookClientAsync", + "parsedDocstring": { + "text": "Sub-client for managing a specific webhook.\n\nProvides methods to manage a specific webhook, e.g. get, update, or delete it. Obtain an instance via an\nappropriate method on the `ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/webhook.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 166 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3917, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 27 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3386, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3387, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3388, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3389, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClient", + "type": "reference", + "target": "1836" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3390, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3391, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistry", + "type": "reference", + "target": "1710" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3392, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3393, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 3385, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3921, + "module": "_resource_clients.run_collection", + "name": "list", + "parsedDocstring": { + "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n", + "args": { + "limit": "How many runs to retrieve.", + "offset": "What run to include as first when retrieving the list.", + "desc": "Whether to sort the runs in descending order based on their start date.", + "status": "Retrieve only runs with the provided statuses.", + "started_before": "Only return runs started before this date (inclusive).", + "started_after": "Only return runs started after this date (inclusive).", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved Actor runs." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 38 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved Actor runs." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n" + } + ] + }, + "flags": {}, + "id": 3922, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many runs to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3923, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What run to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3924, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the runs in descending order based on their start date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3925, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve only runs with the provided statuses." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3926, + "kind": 32768, + "kindString": "Parameter", + "name": "status", + "type": { + "name": "ActorJobStatus | list[ActorJobStatus] | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorJobStatus", + "target": "1794" + }, + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "ActorJobStatus", + "target": "1794" + } + ], + "target": "2199" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Only return runs started before this date (inclusive)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3927, + "kind": 32768, + "kindString": "Parameter", + "name": "started_before", + "type": { + "name": "str | datetime | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "datetime" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Only return runs started after this date (inclusive)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3928, + "kind": 32768, + "kindString": "Parameter", + "name": "started_after", + "type": { + "name": "str | datetime | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "datetime" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3929, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfRuns", + "type": "reference", + "target": "768" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over all Actor runs.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3930, + "module": "_resource_clients.run_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over all Actor runs.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n", + "args": { + "limit": "How many runs to retrieve.", + "offset": "What run to include as first when retrieving the list.", + "desc": "Whether to sort the runs in descending order based on their start date.", + "status": "Retrieve only runs with the provided statuses.", + "started_before": "Only return runs started before this date (inclusive).", + "started_after": "Only return runs started after this date (inclusive).", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 82 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over all Actor runs.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n" + } + ] + }, + "flags": {}, + "id": 3931, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many runs to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3932, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What run to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3933, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the runs in descending order based on their start date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3934, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve only runs with the provided statuses." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3935, + "kind": 32768, + "kindString": "Parameter", + "name": "status", + "type": { + "name": "ActorJobStatus | list[ActorJobStatus] | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorJobStatus", + "target": "1794" + }, + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "ActorJobStatus", + "target": "1794" + } + ], + "target": "2199" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Only return runs started before this date (inclusive)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3936, + "kind": 32768, + "kindString": "Parameter", + "name": "started_before", + "type": { + "name": "str | datetime | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "datetime" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Only return runs started after this date (inclusive)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3937, + "kind": 32768, + "kindString": "Parameter", + "name": "started_after", + "type": { + "name": "str | datetime | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "datetime" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3938, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "Iterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "RunShort", + "target": "1010" + } + ] + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 4017, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the Actor run collection.\n\nProvides methods to manage Actor runs, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClient` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3917, + 3930, + 3921 + ], + "title": "Methods" + }, + { + "children": [ + 4017 + ], + "title": "Properties" + } + ], + "id": 3916, + "module": "_resource_clients.run_collection", + "name": "RunCollectionClient", + "parsedDocstring": { + "text": "Sub-client for the Actor run collection.\n\nProvides methods to manage Actor runs, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClient` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 20 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "3384", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3940, + "module": "_resource_clients._resource_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the resource client.\n", + "args": { + "base_url": "API base URL.", + "public_base_url": "Public CDN base URL.", + "http_client": "HTTP client for making requests.", + "resource_path": "Resource endpoint path (e.g., 'actors', 'datasets').", + "client_registry": "Bundle of client classes for dependency injection.", + "resource_id": "Optional resource ID for single-resource clients.", + "params": "Optional default parameters for all requests." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 136 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the resource client.\n" + } + ] + }, + "flags": {}, + "id": 3396, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "API base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3397, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Public CDN base URL." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3398, + "kind": 32768, + "kindString": "Parameter", + "name": "public_base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP client for making requests." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3399, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "HttpClientAsync", + "type": "reference", + "target": "1847" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource endpoint path (e.g., 'actors', 'datasets')." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3400, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Bundle of client classes for dependency injection." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 3401, + "kind": 32768, + "kindString": "Parameter", + "name": "client_registry", + "type": { + "name": "ClientRegistryAsync", + "type": "reference", + "target": "1738" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional resource ID for single-resource clients." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3402, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "str | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional default parameters for all requests." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3403, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "dict | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "dict" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClientAsync.__init__", + "target": 3395, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3944, + "module": "_resource_clients.run_collection", + "name": "list", + "parsedDocstring": { + "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n", + "args": { + "limit": "How many runs to retrieve.", + "offset": "What run to include as first when retrieving the list.", + "desc": "Whether to sort the runs in descending order based on their start date.", + "status": "Retrieve only runs with the provided statuses.", + "started_before": "Only return runs started before this date (inclusive).", + "started_after": "Only return runs started after this date (inclusive).", + "timeout": "Timeout for the API HTTP request.\n" + }, + "returns": "The retrieved Actor runs." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 147 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "The retrieved Actor runs." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List all Actor runs.\n\nList all Actor runs, either of a single Actor, or all user's Actors, depending on where this client\nwas initialized from.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n" + } + ] + }, + "flags": {}, + "id": 3945, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [ + "async" + ], + "name": "list", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many runs to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3946, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What run to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3947, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the runs in descending order based on their start date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3948, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve only runs with the provided statuses." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3949, + "kind": 32768, + "kindString": "Parameter", + "name": "status", + "type": { + "name": "ActorJobStatus | list[ActorJobStatus] | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorJobStatus", + "target": "1794" + }, + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "ActorJobStatus", + "target": "1794" + } + ], + "target": "2199" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Only return runs started before this date (inclusive)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3950, + "kind": 32768, + "kindString": "Parameter", + "name": "started_before", + "type": { + "name": "str | datetime | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "datetime" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Only return runs started after this date (inclusive)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3951, + "kind": 32768, + "kindString": "Parameter", + "name": "started_after", + "type": { + "name": "str | datetime | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "datetime" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3952, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "ListOfRuns", + "type": "reference", + "target": "768" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over all Actor runs.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 3953, + "module": "_resource_clients.run_collection", + "name": "iterate", + "parsedDocstring": { + "text": "Iterate over all Actor runs.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n", + "args": { + "limit": "How many runs to retrieve.", + "offset": "What run to include as first when retrieving the list.", + "desc": "Whether to sort the runs in descending order based on their start date.", + "status": "Retrieve only runs with the provided statuses.", + "started_before": "Only return runs started before this date (inclusive).", + "started_after": "Only return runs started after this date (inclusive).", + "timeout": "Timeout for the API HTTP request.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 191 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Iterate over all Actor runs.\n\nSimple `list` does only one API call, possibly not listing all items matching the criteria. This method\nreturns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs\nhttps://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list\n" + } + ] + }, + "flags": {}, + "id": 3954, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "iterate", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many runs to retrieve." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3955, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What run to include as first when retrieving the list." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3956, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "int" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the runs in descending order based on their start date." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3957, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "bool | None", + "type": "union", + "types": [ + { + "type": "reference", + "name": "bool" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve only runs with the provided statuses." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3958, + "kind": 32768, + "kindString": "Parameter", + "name": "status", + "type": { + "name": "ActorJobStatus | list[ActorJobStatus] | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "ActorJobStatus", + "target": "1794" + }, + { + "type": "reference", + "name": "list", + "typeArguments": [ + { + "type": "reference", + "name": "ActorJobStatus", + "target": "1794" + } + ], + "target": "2199" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Only return runs started before this date (inclusive)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3959, + "kind": 32768, + "kindString": "Parameter", + "name": "started_before", + "type": { + "name": "str | datetime | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "datetime" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Only return runs started after this date (inclusive)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3960, + "kind": 32768, + "kindString": "Parameter", + "name": "started_after", + "type": { + "name": "str | datetime | None", + "type": "union", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "datetime" + } + ] + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timeout for the API HTTP request.\n" + } + ] + }, + "defaultValue": "'medium'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 3961, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout", + "type": { + "name": "Timeout", + "type": "reference", + "target": "13" + } + } + ], + "type": { + "name": "AsyncIterator", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "RunShort", + "target": "1010" + } + ] + } + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Get the resource ID." + } + ] + }, + "decorations": [ + { + "name": "property" + } + ], + "flags": {}, + "groups": [], + "id": 3990, + "module": "_resource_clients._resource_client", + "name": "resource_id", + "parsedDocstring": { + "text": "Get the resource ID." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/_resource_client.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 72 + } + ], + "type": { + "name": "str | None", + "type": "reference" + }, + "inheritedFrom": { + "name": "ResourceClientBase.resource_id", + "target": 3383, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for the Actor run collection.\n\nProvides methods to manage Actor runs, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class." + } + ] + }, + "decorations": [ + { + "args": "('Resource clients')", + "name": "docs_group" + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 3940, + 3953, + 3944 + ], + "title": "Methods" + }, + { + "children": [ + 3990 + ], + "title": "Properties" + } + ], + "id": 3939, + "module": "_resource_clients.run_collection", + "name": "RunCollectionClientAsync", + "parsedDocstring": { + "text": "Sub-client for the Actor run collection.\n\nProvides methods to manage Actor runs, e.g. list them. Obtain an instance via an appropriate method on the\n`ApifyClientAsync` class." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_resource_clients/run_collection.py", + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183", + "line": 129 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClientAsync", + "target": "3394", + "type": "reference" + } + ] + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 1436, + 1516 + ], + "title": "Apify API clients" + }, + { + "children": [ + 17, + 16, + 32, + 30, + 28, + 35, + 31, + 33, + 34, + 29 + ], + "title": "Errors" + }, + { + "children": [ + 1836, + 1847, + 1824, + 1805, + 1860, + 1882 + ], + "title": "HTTP clients" + }, + { + "children": [ + 187, + 192, + 215, + 220, + 237, + 240, + 243, + 246, + 255, + 265, + 278, + 275, + 284, + 287, + 291, + 294, + 298, + 306, + 324, + 330, + 333, + 353, + 342, + 347, + 350, + 358, + 365, + 369, + 377, + 393, + 404, + 412, + 424, + 427, + 432, + 451, + 457, + 469, + 488, + 472, + 477, + 480, + 483, + 491, + 537, + 496, + 499, + 507, + 511, + 515, + 522, + 534, + 538, + 541, + 546, + 548, + 551, + 555, + 558, + 562, + 566, + 570, + 575, + 578, + 581, + 588, + 591, + 595, + 611, + 616, + 626, + 619, + 629, + 642, + 753, + 645, + 648, + 756, + 651, + 759, + 654, + 657, + 661, + 667, + 675, + 762, + 664, + 765, + 678, + 681, + 688, + 768, + 691, + 771, + 694, + 774, + 777, + 697, + 700, + 704, + 780, + 707, + 783, + 710, + 713, + 721, + 730, + 736, + 743, + 746, + 786, + 791, + 813, + 818, + 825, + 828, + 831, + 839, + 842, + 846, + 851, + 854, + 857, + 859, + 861, + 876, + 863, + 879, + 893, + 885, + 889, + 895, + 898, + 913, + 919, + 945, + 922, + 938, + 948, + 953, + 956, + 958, + 989, + 992, + 999, + 1007, + 1010, + 1025, + 1044, + 1047, + 1061, + 1115, + 1075, + 1082, + 1088, + 1092, + 1097, + 1102, + 1120, + 1130, + 1136, + 1141, + 1146, + 1149, + 1152, + 1155, + 1158, + 1163, + 1167, + 1172, + 1175, + 1192, + 1197, + 1213, + 1215, + 1223, + 1226, + 1238, + 1241, + 1244, + 1247, + 1250, + 1253, + 1256, + 1274, + 1278, + 1282, + 1286, + 1289, + 1295, + 1296, + 1303, + 1307, + 1314, + 1325, + 1329, + 1336, + 1347, + 1350, + 1368, + 1373, + 1386, + 1396, + 1397, + 1403, + 1406, + 1421, + 1424 + ], + "title": "Models" + }, + { + "children": [ + 2812, + 1693, + 1676, + 44, + 61 + ], + "title": "Other" + }, + { + "children": [ + 3404, + 3506, + 2262, + 2308, + 3758, + 3776, + 2194, + 2211, + 2424, + 2452, + 3275, + 3298, + 3171, + 3195, + 2778, + 2795, + 2819, + 2926, + 3321, + 3347, + 3608, + 3683, + 2372, + 2398, + 2160, + 2177, + 1996, + 2078, + 2480, + 2505, + 3384, + 3394, + 3033, + 3102, + 3916, + 3939, + 1904, + 1930, + 3219, + 3247, + 2598, + 2623, + 2648, + 2713, + 2530, + 2564, + 1956, + 1976, + 3856, + 3886, + 3794, + 3825, + 2354, + 2363, + 2228, + 2245 + ], + "title": "Resource clients" + }, + { + "children": [ + 90, + 78, + 104, + 102, + 111, + 119, + 116, + 125, + 122, + 106, + 138, + 134, + 154, + 142, + 171, + 166 + ], + "title": "Typed dicts" + } + ], + "id": 0, + "kind": 1, + "kindString": "Project", + "name": "apify-client", + "sources": [ + { + "character": 0, + "fileName": "src/index.ts", + "line": 1, + "gitRevision": "cb35ed76b4894c669e128dc031bbbfec68825183" + } + ], + "symbolIdMap": { + "1": { + "qualifiedName": "ClientStatistics", + "sourceFileName": "/src/apify_client/_statistics.py" + }, + "2": { + "qualifiedName": "calls", + "sourceFileName": "/src/apify_client/_statistics.py" + }, + "3": { + "qualifiedName": "requests", + "sourceFileName": "/src/apify_client/_statistics.py" + }, + "4": { + "qualifiedName": "rate_limit_errors", + "sourceFileName": "/src/apify_client/_statistics.py" + }, + "5": { + "qualifiedName": "add_rate_limit_error", + "sourceFileName": "/src/apify_client/_statistics.py" + }, + "8": { + "qualifiedName": "GroupName", + "sourceFileName": "/src/apify_client/_docs.py" + }, + "9": { + "qualifiedName": "T", + "sourceFileName": "/src/apify_client/_docs.py" + }, + "10": { + "qualifiedName": "docs_group", + "sourceFileName": "/src/apify_client/_docs.py" + }, + "13": { + "qualifiedName": "Timeout", + "sourceFileName": "/src/apify_client/types.py" + }, + "14": { + "qualifiedName": "WebhooksList", + "sourceFileName": "/src/apify_client/types.py" + }, + "15": { + "qualifiedName": "JsonSerializable", + "sourceFileName": "/src/apify_client/types.py" + }, + "16": { + "qualifiedName": "ApifyClientError", + "sourceFileName": "/src/apify_client/errors.py" + }, + "17": { + "qualifiedName": "ApifyApiError", + "sourceFileName": "/src/apify_client/errors.py" + }, + "18": { + "qualifiedName": "__new__", + "sourceFileName": "/src/apify_client/errors.py" + }, + "23": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/errors.py" + }, + "28": { + "qualifiedName": "InvalidRequestError", + "sourceFileName": "/src/apify_client/errors.py" + }, + "29": { + "qualifiedName": "UnauthorizedError", + "sourceFileName": "/src/apify_client/errors.py" + }, + "30": { + "qualifiedName": "ForbiddenError", + "sourceFileName": "/src/apify_client/errors.py" + }, + "31": { + "qualifiedName": "NotFoundError", + "sourceFileName": "/src/apify_client/errors.py" + }, + "32": { + "qualifiedName": "ConflictError", + "sourceFileName": "/src/apify_client/errors.py" + }, + "33": { + "qualifiedName": "RateLimitError", + "sourceFileName": "/src/apify_client/errors.py" + }, + "34": { + "qualifiedName": "ServerError", + "sourceFileName": "/src/apify_client/errors.py" + }, + "35": { + "qualifiedName": "InvalidResponseBodyError", + "sourceFileName": "/src/apify_client/errors.py" + }, + "36": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/errors.py" + }, + "39": { + "qualifiedName": "StreamedLogBase", + "sourceFileName": "/src/apify_client/_streamed_log.py" + }, + "40": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_streamed_log.py" + }, + "44": { + "qualifiedName": "StreamedLog", + "sourceFileName": "/src/apify_client/_streamed_log.py" + }, + "45": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_streamed_log.py" + }, + "50": { + "qualifiedName": "start", + "sourceFileName": "/src/apify_client/_streamed_log.py" + }, + "52": { + "qualifiedName": "stop", + "sourceFileName": "/src/apify_client/_streamed_log.py" + }, + "54": { + "qualifiedName": "__enter__", + "sourceFileName": "/src/apify_client/_streamed_log.py" + }, + "56": { + "qualifiedName": "__exit__", + "sourceFileName": "/src/apify_client/_streamed_log.py" + }, + "61": { + "qualifiedName": "StreamedLogAsync", + "sourceFileName": "/src/apify_client/_streamed_log.py" + }, + "62": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_streamed_log.py" + }, + "67": { + "qualifiedName": "start", + "sourceFileName": "/src/apify_client/_streamed_log.py" + }, + "69": { + "qualifiedName": "stop", + "sourceFileName": "/src/apify_client/_streamed_log.py" + }, + "71": { + "qualifiedName": "__aenter__", + "sourceFileName": "/src/apify_client/_streamed_log.py" + }, + "73": { + "qualifiedName": "__aexit__", + "sourceFileName": "/src/apify_client/_streamed_log.py" + }, + "78": { + "qualifiedName": "RequestBaseDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "79": { + "qualifiedName": "unique_key", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "80": { + "qualifiedName": "url", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "81": { + "qualifiedName": "method", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "82": { + "qualifiedName": "retry_count", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "83": { + "qualifiedName": "loaded_url", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "84": { + "qualifiedName": "payload", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "85": { + "qualifiedName": "headers", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "86": { + "qualifiedName": "user_data", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "87": { + "qualifiedName": "no_retry", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "88": { + "qualifiedName": "error_messages", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "89": { + "qualifiedName": "handled_at", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "90": { + "qualifiedName": "RequestBaseCamelDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "91": { + "qualifiedName": "uniqueKey", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "92": { + "qualifiedName": "url", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "93": { + "qualifiedName": "method", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "94": { + "qualifiedName": "retryCount", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "95": { + "qualifiedName": "loadedUrl", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "96": { + "qualifiedName": "payload", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "97": { + "qualifiedName": "headers", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "98": { + "qualifiedName": "userData", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "99": { + "qualifiedName": "noRetry", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "100": { + "qualifiedName": "errorMessages", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "101": { + "qualifiedName": "handledAt", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "102": { + "qualifiedName": "RequestDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "103": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "104": { + "qualifiedName": "RequestCamelDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "105": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "106": { + "qualifiedName": "RequestDraftDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "107": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "108": { + "qualifiedName": "unique_key", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "109": { + "qualifiedName": "url", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "110": { + "qualifiedName": "method", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "111": { + "qualifiedName": "RequestDraftCamelDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "112": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "113": { + "qualifiedName": "uniqueKey", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "114": { + "qualifiedName": "url", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "115": { + "qualifiedName": "method", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "116": { + "qualifiedName": "RequestDraftDeleteByIdDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "117": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "118": { + "qualifiedName": "unique_key", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "119": { + "qualifiedName": "RequestDraftDeleteByIdCamelDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "120": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "121": { + "qualifiedName": "uniqueKey", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "122": { + "qualifiedName": "RequestDraftDeleteByUniqueKeyDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "123": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "124": { + "qualifiedName": "unique_key", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "125": { + "qualifiedName": "RequestDraftDeleteByUniqueKeyCamelDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "126": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "127": { + "qualifiedName": "uniqueKey", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "128": { + "qualifiedName": "RequestDraftDeleteDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "129": { + "qualifiedName": "RequestDraftDeleteCamelDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "130": { + "qualifiedName": "RequestUserDataDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "131": { + "qualifiedName": "RequestUserDataCamelDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "132": { + "qualifiedName": "TaskInputDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "133": { + "qualifiedName": "TaskInputCamelDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "134": { + "qualifiedName": "WebhookConditionDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "135": { + "qualifiedName": "actor_id", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "136": { + "qualifiedName": "actor_task_id", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "137": { + "qualifiedName": "actor_run_id", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "138": { + "qualifiedName": "WebhookConditionCamelDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "139": { + "qualifiedName": "actorId", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "140": { + "qualifiedName": "actorTaskId", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "141": { + "qualifiedName": "actorRunId", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "142": { + "qualifiedName": "WebhookCreateDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "143": { + "qualifiedName": "is_ad_hoc", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "144": { + "qualifiedName": "event_types", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "145": { + "qualifiedName": "condition", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "146": { + "qualifiedName": "idempotency_key", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "147": { + "qualifiedName": "ignore_ssl_errors", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "148": { + "qualifiedName": "do_not_retry", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "149": { + "qualifiedName": "request_url", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "150": { + "qualifiedName": "payload_template", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "151": { + "qualifiedName": "headers_template", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "152": { + "qualifiedName": "description", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "153": { + "qualifiedName": "should_interpolate_strings", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "154": { + "qualifiedName": "WebhookCreateCamelDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "155": { + "qualifiedName": "isAdHoc", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "156": { + "qualifiedName": "eventTypes", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "157": { + "qualifiedName": "condition", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "158": { + "qualifiedName": "idempotencyKey", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "159": { + "qualifiedName": "ignoreSslErrors", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "160": { + "qualifiedName": "doNotRetry", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "161": { + "qualifiedName": "requestUrl", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "162": { + "qualifiedName": "payloadTemplate", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "163": { + "qualifiedName": "headersTemplate", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "164": { + "qualifiedName": "description", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "165": { + "qualifiedName": "shouldInterpolateStrings", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "166": { + "qualifiedName": "WebhookRepresentationDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "167": { + "qualifiedName": "event_types", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "168": { + "qualifiedName": "request_url", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "169": { + "qualifiedName": "payload_template", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "170": { + "qualifiedName": "headers_template", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "171": { + "qualifiedName": "WebhookRepresentationCamelDict", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "172": { + "qualifiedName": "eventTypes", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "173": { + "qualifiedName": "requestUrl", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "174": { + "qualifiedName": "payloadTemplate", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "175": { + "qualifiedName": "headersTemplate", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "176": { + "qualifiedName": "DEFAULT_API_URL", + "sourceFileName": "/src/apify_client/_consts.py" + }, + "177": { + "qualifiedName": "API_VERSION", + "sourceFileName": "/src/apify_client/_consts.py" + }, + "178": { + "qualifiedName": "DEFAULT_TIMEOUT_SHORT", + "sourceFileName": "/src/apify_client/_consts.py" + }, + "179": { + "qualifiedName": "DEFAULT_TIMEOUT_MEDIUM", + "sourceFileName": "/src/apify_client/_consts.py" + }, + "180": { + "qualifiedName": "DEFAULT_TIMEOUT_LONG", + "sourceFileName": "/src/apify_client/_consts.py" + }, + "181": { + "qualifiedName": "DEFAULT_TIMEOUT_MAX", + "sourceFileName": "/src/apify_client/_consts.py" + }, + "182": { + "qualifiedName": "DEFAULT_MAX_RETRIES", + "sourceFileName": "/src/apify_client/_consts.py" + }, + "183": { + "qualifiedName": "DEFAULT_MIN_DELAY_BETWEEN_RETRIES", + "sourceFileName": "/src/apify_client/_consts.py" + }, + "184": { + "qualifiedName": "DEFAULT_WAIT_FOR_FINISH", + "sourceFileName": "/src/apify_client/_consts.py" + }, + "185": { + "qualifiedName": "DEFAULT_WAIT_WHEN_JOB_NOT_EXIST", + "sourceFileName": "/src/apify_client/_consts.py" + }, + "186": { + "qualifiedName": "OVERRIDABLE_DEFAULT_HEADERS", + "sourceFileName": "/src/apify_client/_consts.py" + }, + "187": { + "qualifiedName": "AccountLimits", + "sourceFileName": "/src/apify_client/_models.py" + }, + "188": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "189": { + "qualifiedName": "monthly_usage_cycle", + "sourceFileName": "/src/apify_client/_models.py" + }, + "190": { + "qualifiedName": "limits", + "sourceFileName": "/src/apify_client/_models.py" + }, + "191": { + "qualifiedName": "current", + "sourceFileName": "/src/apify_client/_models.py" + }, + "192": { + "qualifiedName": "Actor", + "sourceFileName": "/src/apify_client/_models.py" + }, + "193": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "194": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "195": { + "qualifiedName": "user_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "196": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "197": { + "qualifiedName": "username", + "sourceFileName": "/src/apify_client/_models.py" + }, + "198": { + "qualifiedName": "description", + "sourceFileName": "/src/apify_client/_models.py" + }, + "199": { + "qualifiedName": "restart_on_error", + "sourceFileName": "/src/apify_client/_models.py" + }, + "200": { + "qualifiedName": "is_public", + "sourceFileName": "/src/apify_client/_models.py" + }, + "201": { + "qualifiedName": "actor_permission_level", + "sourceFileName": "/src/apify_client/_models.py" + }, + "202": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "203": { + "qualifiedName": "modified_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "204": { + "qualifiedName": "stats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "205": { + "qualifiedName": "versions", + "sourceFileName": "/src/apify_client/_models.py" + }, + "206": { + "qualifiedName": "pricing_infos", + "sourceFileName": "/src/apify_client/_models.py" + }, + "207": { + "qualifiedName": "default_run_options", + "sourceFileName": "/src/apify_client/_models.py" + }, + "208": { + "qualifiedName": "example_run_input", + "sourceFileName": "/src/apify_client/_models.py" + }, + "209": { + "qualifiedName": "is_deprecated", + "sourceFileName": "/src/apify_client/_models.py" + }, + "210": { + "qualifiedName": "deployment_key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "211": { + "qualifiedName": "title", + "sourceFileName": "/src/apify_client/_models.py" + }, + "212": { + "qualifiedName": "tagged_builds", + "sourceFileName": "/src/apify_client/_models.py" + }, + "213": { + "qualifiedName": "actor_standby", + "sourceFileName": "/src/apify_client/_models.py" + }, + "214": { + "qualifiedName": "readme_summary", + "sourceFileName": "/src/apify_client/_models.py" + }, + "215": { + "qualifiedName": "ActorChargeEvent", + "sourceFileName": "/src/apify_client/_models.py" + }, + "216": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "217": { + "qualifiedName": "event_price_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "218": { + "qualifiedName": "event_title", + "sourceFileName": "/src/apify_client/_models.py" + }, + "219": { + "qualifiedName": "event_description", + "sourceFileName": "/src/apify_client/_models.py" + }, + "220": { + "qualifiedName": "ActorDefinition", + "sourceFileName": "/src/apify_client/_models.py" + }, + "221": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "222": { + "qualifiedName": "actor_specification", + "sourceFileName": "/src/apify_client/_models.py" + }, + "223": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "224": { + "qualifiedName": "version", + "sourceFileName": "/src/apify_client/_models.py" + }, + "225": { + "qualifiedName": "build_tag", + "sourceFileName": "/src/apify_client/_models.py" + }, + "226": { + "qualifiedName": "environment_variables", + "sourceFileName": "/src/apify_client/_models.py" + }, + "227": { + "qualifiedName": "dockerfile", + "sourceFileName": "/src/apify_client/_models.py" + }, + "228": { + "qualifiedName": "docker_context_dir", + "sourceFileName": "/src/apify_client/_models.py" + }, + "229": { + "qualifiedName": "readme", + "sourceFileName": "/src/apify_client/_models.py" + }, + "230": { + "qualifiedName": "input", + "sourceFileName": "/src/apify_client/_models.py" + }, + "231": { + "qualifiedName": "changelog", + "sourceFileName": "/src/apify_client/_models.py" + }, + "232": { + "qualifiedName": "storages", + "sourceFileName": "/src/apify_client/_models.py" + }, + "233": { + "qualifiedName": "default_memory_mbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "234": { + "qualifiedName": "min_memory_mbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "235": { + "qualifiedName": "max_memory_mbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "236": { + "qualifiedName": "uses_standby_mode", + "sourceFileName": "/src/apify_client/_models.py" + }, + "237": { + "qualifiedName": "ActorResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "238": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "239": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "240": { + "qualifiedName": "ActorRunFailedError", + "sourceFileName": "/src/apify_client/_models.py" + }, + "241": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "242": { + "qualifiedName": "error", + "sourceFileName": "/src/apify_client/_models.py" + }, + "243": { + "qualifiedName": "ActorRunTimeoutExceededError", + "sourceFileName": "/src/apify_client/_models.py" + }, + "244": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "245": { + "qualifiedName": "error", + "sourceFileName": "/src/apify_client/_models.py" + }, + "246": { + "qualifiedName": "ActorShort", + "sourceFileName": "/src/apify_client/_models.py" + }, + "247": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "248": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "249": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "250": { + "qualifiedName": "modified_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "251": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "252": { + "qualifiedName": "username", + "sourceFileName": "/src/apify_client/_models.py" + }, + "253": { + "qualifiedName": "title", + "sourceFileName": "/src/apify_client/_models.py" + }, + "254": { + "qualifiedName": "stats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "255": { + "qualifiedName": "ActorStandby", + "sourceFileName": "/src/apify_client/_models.py" + }, + "256": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "257": { + "qualifiedName": "is_enabled", + "sourceFileName": "/src/apify_client/_models.py" + }, + "258": { + "qualifiedName": "desired_requests_per_actor_run", + "sourceFileName": "/src/apify_client/_models.py" + }, + "259": { + "qualifiedName": "max_requests_per_actor_run", + "sourceFileName": "/src/apify_client/_models.py" + }, + "260": { + "qualifiedName": "idle_timeout_secs", + "sourceFileName": "/src/apify_client/_models.py" + }, + "261": { + "qualifiedName": "build", + "sourceFileName": "/src/apify_client/_models.py" + }, + "262": { + "qualifiedName": "memory_mbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "263": { + "qualifiedName": "disable_standby_fields_override", + "sourceFileName": "/src/apify_client/_models.py" + }, + "264": { + "qualifiedName": "should_pass_actor_input", + "sourceFileName": "/src/apify_client/_models.py" + }, + "265": { + "qualifiedName": "ActorStats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "266": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "267": { + "qualifiedName": "total_builds", + "sourceFileName": "/src/apify_client/_models.py" + }, + "268": { + "qualifiedName": "total_runs", + "sourceFileName": "/src/apify_client/_models.py" + }, + "269": { + "qualifiedName": "total_users", + "sourceFileName": "/src/apify_client/_models.py" + }, + "270": { + "qualifiedName": "total_users7_days", + "sourceFileName": "/src/apify_client/_models.py" + }, + "271": { + "qualifiedName": "total_users30_days", + "sourceFileName": "/src/apify_client/_models.py" + }, + "272": { + "qualifiedName": "total_users90_days", + "sourceFileName": "/src/apify_client/_models.py" + }, + "273": { + "qualifiedName": "total_metamorphs", + "sourceFileName": "/src/apify_client/_models.py" + }, + "274": { + "qualifiedName": "last_run_started_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "275": { + "qualifiedName": "AddRequestResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "276": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "277": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "278": { + "qualifiedName": "AddedRequest", + "sourceFileName": "/src/apify_client/_models.py" + }, + "279": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "280": { + "qualifiedName": "request_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "281": { + "qualifiedName": "unique_key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "282": { + "qualifiedName": "was_already_present", + "sourceFileName": "/src/apify_client/_models.py" + }, + "283": { + "qualifiedName": "was_already_handled", + "sourceFileName": "/src/apify_client/_models.py" + }, + "284": { + "qualifiedName": "BatchAddResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "285": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "286": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "287": { + "qualifiedName": "BatchAddResult", + "sourceFileName": "/src/apify_client/_models.py" + }, + "288": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "289": { + "qualifiedName": "processed_requests", + "sourceFileName": "/src/apify_client/_models.py" + }, + "290": { + "qualifiedName": "unprocessed_requests", + "sourceFileName": "/src/apify_client/_models.py" + }, + "291": { + "qualifiedName": "BatchDeleteResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "292": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "293": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "294": { + "qualifiedName": "BatchDeleteResult", + "sourceFileName": "/src/apify_client/_models.py" + }, + "295": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "296": { + "qualifiedName": "processed_requests", + "sourceFileName": "/src/apify_client/_models.py" + }, + "297": { + "qualifiedName": "unprocessed_requests", + "sourceFileName": "/src/apify_client/_models.py" + }, + "298": { + "qualifiedName": "BrowserInfoResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "299": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "300": { + "qualifiedName": "method", + "sourceFileName": "/src/apify_client/_models.py" + }, + "301": { + "qualifiedName": "client_ip", + "sourceFileName": "/src/apify_client/_models.py" + }, + "302": { + "qualifiedName": "country_code", + "sourceFileName": "/src/apify_client/_models.py" + }, + "303": { + "qualifiedName": "body_length", + "sourceFileName": "/src/apify_client/_models.py" + }, + "304": { + "qualifiedName": "headers", + "sourceFileName": "/src/apify_client/_models.py" + }, + "305": { + "qualifiedName": "raw_headers", + "sourceFileName": "/src/apify_client/_models.py" + }, + "306": { + "qualifiedName": "Build", + "sourceFileName": "/src/apify_client/_models.py" + }, + "307": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "308": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "309": { + "qualifiedName": "act_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "310": { + "qualifiedName": "user_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "311": { + "qualifiedName": "started_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "312": { + "qualifiedName": "finished_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "313": { + "qualifiedName": "status", + "sourceFileName": "/src/apify_client/_models.py" + }, + "314": { + "qualifiedName": "meta", + "sourceFileName": "/src/apify_client/_models.py" + }, + "315": { + "qualifiedName": "stats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "316": { + "qualifiedName": "options", + "sourceFileName": "/src/apify_client/_models.py" + }, + "317": { + "qualifiedName": "usage", + "sourceFileName": "/src/apify_client/_models.py" + }, + "318": { + "qualifiedName": "usage_total_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "319": { + "qualifiedName": "usage_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "320": { + "qualifiedName": "input_schema", + "sourceFileName": "/src/apify_client/_models.py" + }, + "321": { + "qualifiedName": "readme", + "sourceFileName": "/src/apify_client/_models.py" + }, + "322": { + "qualifiedName": "build_number", + "sourceFileName": "/src/apify_client/_models.py" + }, + "323": { + "qualifiedName": "actor_definition", + "sourceFileName": "/src/apify_client/_models.py" + }, + "324": { + "qualifiedName": "BuildOptions", + "sourceFileName": "/src/apify_client/_models.py" + }, + "325": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "326": { + "qualifiedName": "use_cache", + "sourceFileName": "/src/apify_client/_models.py" + }, + "327": { + "qualifiedName": "beta_packages", + "sourceFileName": "/src/apify_client/_models.py" + }, + "328": { + "qualifiedName": "memory_mbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "329": { + "qualifiedName": "disk_mbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "330": { + "qualifiedName": "BuildResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "331": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "332": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "333": { + "qualifiedName": "BuildShort", + "sourceFileName": "/src/apify_client/_models.py" + }, + "334": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "335": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "336": { + "qualifiedName": "act_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "337": { + "qualifiedName": "status", + "sourceFileName": "/src/apify_client/_models.py" + }, + "338": { + "qualifiedName": "started_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "339": { + "qualifiedName": "finished_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "340": { + "qualifiedName": "usage_total_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "341": { + "qualifiedName": "meta", + "sourceFileName": "/src/apify_client/_models.py" + }, + "342": { + "qualifiedName": "BuildStats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "343": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "344": { + "qualifiedName": "duration_millis", + "sourceFileName": "/src/apify_client/_models.py" + }, + "345": { + "qualifiedName": "run_time_secs", + "sourceFileName": "/src/apify_client/_models.py" + }, + "346": { + "qualifiedName": "compute_units", + "sourceFileName": "/src/apify_client/_models.py" + }, + "347": { + "qualifiedName": "BuildTag", + "sourceFileName": "/src/apify_client/_models.py" + }, + "348": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "349": { + "qualifiedName": "build_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "350": { + "qualifiedName": "BuildUsage", + "sourceFileName": "/src/apify_client/_models.py" + }, + "351": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "352": { + "qualifiedName": "actor_compute_units", + "sourceFileName": "/src/apify_client/_models.py" + }, + "353": { + "qualifiedName": "BuildsMeta", + "sourceFileName": "/src/apify_client/_models.py" + }, + "354": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "355": { + "qualifiedName": "origin", + "sourceFileName": "/src/apify_client/_models.py" + }, + "356": { + "qualifiedName": "client_ip", + "sourceFileName": "/src/apify_client/_models.py" + }, + "357": { + "qualifiedName": "user_agent", + "sourceFileName": "/src/apify_client/_models.py" + }, + "358": { + "qualifiedName": "Call", + "sourceFileName": "/src/apify_client/_models.py" + }, + "359": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "360": { + "qualifiedName": "started_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "361": { + "qualifiedName": "finished_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "362": { + "qualifiedName": "error_message", + "sourceFileName": "/src/apify_client/_models.py" + }, + "363": { + "qualifiedName": "response_status", + "sourceFileName": "/src/apify_client/_models.py" + }, + "364": { + "qualifiedName": "response_body", + "sourceFileName": "/src/apify_client/_models.py" + }, + "365": { + "qualifiedName": "ChargeRunRequest", + "sourceFileName": "/src/apify_client/_models.py" + }, + "366": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "367": { + "qualifiedName": "event_name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "368": { + "qualifiedName": "count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "369": { + "qualifiedName": "CommonActorPricingInfo", + "sourceFileName": "/src/apify_client/_models.py" + }, + "370": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "371": { + "qualifiedName": "apify_margin_percentage", + "sourceFileName": "/src/apify_client/_models.py" + }, + "372": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "373": { + "qualifiedName": "started_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "374": { + "qualifiedName": "notified_about_future_change_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "375": { + "qualifiedName": "notified_about_change_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "376": { + "qualifiedName": "reason_for_change", + "sourceFileName": "/src/apify_client/_models.py" + }, + "377": { + "qualifiedName": "CreateActorRequest", + "sourceFileName": "/src/apify_client/_models.py" + }, + "378": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "379": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "380": { + "qualifiedName": "description", + "sourceFileName": "/src/apify_client/_models.py" + }, + "381": { + "qualifiedName": "title", + "sourceFileName": "/src/apify_client/_models.py" + }, + "382": { + "qualifiedName": "is_public", + "sourceFileName": "/src/apify_client/_models.py" + }, + "383": { + "qualifiedName": "seo_title", + "sourceFileName": "/src/apify_client/_models.py" + }, + "384": { + "qualifiedName": "seo_description", + "sourceFileName": "/src/apify_client/_models.py" + }, + "385": { + "qualifiedName": "restart_on_error", + "sourceFileName": "/src/apify_client/_models.py" + }, + "386": { + "qualifiedName": "versions", + "sourceFileName": "/src/apify_client/_models.py" + }, + "387": { + "qualifiedName": "pricing_infos", + "sourceFileName": "/src/apify_client/_models.py" + }, + "388": { + "qualifiedName": "categories", + "sourceFileName": "/src/apify_client/_models.py" + }, + "389": { + "qualifiedName": "default_run_options", + "sourceFileName": "/src/apify_client/_models.py" + }, + "390": { + "qualifiedName": "actor_standby", + "sourceFileName": "/src/apify_client/_models.py" + }, + "391": { + "qualifiedName": "example_run_input", + "sourceFileName": "/src/apify_client/_models.py" + }, + "392": { + "qualifiedName": "is_deprecated", + "sourceFileName": "/src/apify_client/_models.py" + }, + "393": { + "qualifiedName": "CreateOrUpdateVersionRequest", + "sourceFileName": "/src/apify_client/_models.py" + }, + "394": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "395": { + "qualifiedName": "version_number", + "sourceFileName": "/src/apify_client/_models.py" + }, + "396": { + "qualifiedName": "source_type", + "sourceFileName": "/src/apify_client/_models.py" + }, + "397": { + "qualifiedName": "env_vars", + "sourceFileName": "/src/apify_client/_models.py" + }, + "398": { + "qualifiedName": "apply_env_vars_to_build", + "sourceFileName": "/src/apify_client/_models.py" + }, + "399": { + "qualifiedName": "build_tag", + "sourceFileName": "/src/apify_client/_models.py" + }, + "400": { + "qualifiedName": "source_files", + "sourceFileName": "/src/apify_client/_models.py" + }, + "401": { + "qualifiedName": "git_repo_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "402": { + "qualifiedName": "tarball_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "403": { + "qualifiedName": "github_gist_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "404": { + "qualifiedName": "CreateTaskRequest", + "sourceFileName": "/src/apify_client/_models.py" + }, + "405": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "406": { + "qualifiedName": "act_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "407": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "408": { + "qualifiedName": "options", + "sourceFileName": "/src/apify_client/_models.py" + }, + "409": { + "qualifiedName": "input", + "sourceFileName": "/src/apify_client/_models.py" + }, + "410": { + "qualifiedName": "title", + "sourceFileName": "/src/apify_client/_models.py" + }, + "411": { + "qualifiedName": "actor_standby", + "sourceFileName": "/src/apify_client/_models.py" + }, + "412": { + "qualifiedName": "Current", + "sourceFileName": "/src/apify_client/_models.py" + }, + "413": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "414": { + "qualifiedName": "monthly_usage_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "415": { + "qualifiedName": "monthly_actor_compute_units", + "sourceFileName": "/src/apify_client/_models.py" + }, + "416": { + "qualifiedName": "monthly_external_data_transfer_gbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "417": { + "qualifiedName": "monthly_proxy_serps", + "sourceFileName": "/src/apify_client/_models.py" + }, + "418": { + "qualifiedName": "monthly_residential_proxy_gbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "419": { + "qualifiedName": "actor_memory_gbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "420": { + "qualifiedName": "actor_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "421": { + "qualifiedName": "actor_task_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "422": { + "qualifiedName": "active_actor_job_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "423": { + "qualifiedName": "team_account_seat_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "424": { + "qualifiedName": "CurrentPricingInfo", + "sourceFileName": "/src/apify_client/_models.py" + }, + "425": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "426": { + "qualifiedName": "pricing_model", + "sourceFileName": "/src/apify_client/_models.py" + }, + "427": { + "qualifiedName": "DailyServiceUsages", + "sourceFileName": "/src/apify_client/_models.py" + }, + "428": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "429": { + "qualifiedName": "date", + "sourceFileName": "/src/apify_client/_models.py" + }, + "430": { + "qualifiedName": "service_usage", + "sourceFileName": "/src/apify_client/_models.py" + }, + "431": { + "qualifiedName": "total_usage_credits_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "432": { + "qualifiedName": "Dataset", + "sourceFileName": "/src/apify_client/_models.py" + }, + "433": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "434": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "435": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "436": { + "qualifiedName": "user_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "437": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "438": { + "qualifiedName": "modified_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "439": { + "qualifiedName": "accessed_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "440": { + "qualifiedName": "item_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "441": { + "qualifiedName": "clean_item_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "442": { + "qualifiedName": "act_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "443": { + "qualifiedName": "act_run_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "444": { + "qualifiedName": "fields", + "sourceFileName": "/src/apify_client/_models.py" + }, + "445": { + "qualifiedName": "schema_", + "sourceFileName": "/src/apify_client/_models.py" + }, + "446": { + "qualifiedName": "console_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "447": { + "qualifiedName": "items_public_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "448": { + "qualifiedName": "url_signing_secret_key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "449": { + "qualifiedName": "general_access", + "sourceFileName": "/src/apify_client/_models.py" + }, + "450": { + "qualifiedName": "stats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "451": { + "qualifiedName": "DatasetFieldStatistics", + "sourceFileName": "/src/apify_client/_models.py" + }, + "452": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "453": { + "qualifiedName": "min", + "sourceFileName": "/src/apify_client/_models.py" + }, + "454": { + "qualifiedName": "max", + "sourceFileName": "/src/apify_client/_models.py" + }, + "455": { + "qualifiedName": "null_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "456": { + "qualifiedName": "empty_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "457": { + "qualifiedName": "DatasetListItem", + "sourceFileName": "/src/apify_client/_models.py" + }, + "458": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "459": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "460": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "461": { + "qualifiedName": "user_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "462": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "463": { + "qualifiedName": "modified_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "464": { + "qualifiedName": "accessed_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "465": { + "qualifiedName": "item_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "466": { + "qualifiedName": "clean_item_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "467": { + "qualifiedName": "act_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "468": { + "qualifiedName": "act_run_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "469": { + "qualifiedName": "DatasetResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "470": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "471": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "472": { + "qualifiedName": "DatasetSchemaValidationError", + "sourceFileName": "/src/apify_client/_models.py" + }, + "473": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "474": { + "qualifiedName": "type", + "sourceFileName": "/src/apify_client/_models.py" + }, + "475": { + "qualifiedName": "message", + "sourceFileName": "/src/apify_client/_models.py" + }, + "476": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "477": { + "qualifiedName": "DatasetStatistics", + "sourceFileName": "/src/apify_client/_models.py" + }, + "478": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "479": { + "qualifiedName": "field_statistics", + "sourceFileName": "/src/apify_client/_models.py" + }, + "480": { + "qualifiedName": "DatasetStatisticsResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "481": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "482": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "483": { + "qualifiedName": "DatasetStats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "484": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "485": { + "qualifiedName": "read_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "486": { + "qualifiedName": "write_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "487": { + "qualifiedName": "storage_bytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "488": { + "qualifiedName": "Datasets", + "sourceFileName": "/src/apify_client/_models.py" + }, + "489": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "490": { + "qualifiedName": "default", + "sourceFileName": "/src/apify_client/_models.py" + }, + "491": { + "qualifiedName": "DecodeAndVerifyData", + "sourceFileName": "/src/apify_client/_models.py" + }, + "492": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "493": { + "qualifiedName": "decoded", + "sourceFileName": "/src/apify_client/_models.py" + }, + "494": { + "qualifiedName": "encoded_by_user_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "495": { + "qualifiedName": "is_verified_user", + "sourceFileName": "/src/apify_client/_models.py" + }, + "496": { + "qualifiedName": "DecodeAndVerifyResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "497": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "498": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "499": { + "qualifiedName": "DefaultRunOptions", + "sourceFileName": "/src/apify_client/_models.py" + }, + "500": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "501": { + "qualifiedName": "build", + "sourceFileName": "/src/apify_client/_models.py" + }, + "502": { + "qualifiedName": "timeout_secs", + "sourceFileName": "/src/apify_client/_models.py" + }, + "503": { + "qualifiedName": "memory_mbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "504": { + "qualifiedName": "restart_on_error", + "sourceFileName": "/src/apify_client/_models.py" + }, + "505": { + "qualifiedName": "max_items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "506": { + "qualifiedName": "force_permission_level", + "sourceFileName": "/src/apify_client/_models.py" + }, + "507": { + "qualifiedName": "DeletedRequestById", + "sourceFileName": "/src/apify_client/_models.py" + }, + "508": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "509": { + "qualifiedName": "unique_key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "510": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "511": { + "qualifiedName": "DeletedRequestByUniqueKey", + "sourceFileName": "/src/apify_client/_models.py" + }, + "512": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "513": { + "qualifiedName": "unique_key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "514": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "515": { + "qualifiedName": "EffectivePlatformFeature", + "sourceFileName": "/src/apify_client/_models.py" + }, + "516": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "517": { + "qualifiedName": "is_enabled", + "sourceFileName": "/src/apify_client/_models.py" + }, + "518": { + "qualifiedName": "disabled_reason", + "sourceFileName": "/src/apify_client/_models.py" + }, + "519": { + "qualifiedName": "disabled_reason_type", + "sourceFileName": "/src/apify_client/_models.py" + }, + "520": { + "qualifiedName": "is_trial", + "sourceFileName": "/src/apify_client/_models.py" + }, + "521": { + "qualifiedName": "trial_expiration_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "522": { + "qualifiedName": "EffectivePlatformFeatures", + "sourceFileName": "/src/apify_client/_models.py" + }, + "523": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "524": { + "qualifiedName": "actors", + "sourceFileName": "/src/apify_client/_models.py" + }, + "525": { + "qualifiedName": "storage", + "sourceFileName": "/src/apify_client/_models.py" + }, + "526": { + "qualifiedName": "scheduler", + "sourceFileName": "/src/apify_client/_models.py" + }, + "527": { + "qualifiedName": "proxy", + "sourceFileName": "/src/apify_client/_models.py" + }, + "528": { + "qualifiedName": "proxy_external_access", + "sourceFileName": "/src/apify_client/_models.py" + }, + "529": { + "qualifiedName": "proxy_residential", + "sourceFileName": "/src/apify_client/_models.py" + }, + "530": { + "qualifiedName": "proxy_serps", + "sourceFileName": "/src/apify_client/_models.py" + }, + "531": { + "qualifiedName": "webhooks", + "sourceFileName": "/src/apify_client/_models.py" + }, + "532": { + "qualifiedName": "actors_public_all", + "sourceFileName": "/src/apify_client/_models.py" + }, + "533": { + "qualifiedName": "actors_public_developer", + "sourceFileName": "/src/apify_client/_models.py" + }, + "534": { + "qualifiedName": "EncodeAndSignData", + "sourceFileName": "/src/apify_client/_models.py" + }, + "535": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "536": { + "qualifiedName": "encoded", + "sourceFileName": "/src/apify_client/_models.py" + }, + "537": { + "qualifiedName": "DecodeAndVerifyRequest", + "sourceFileName": "/src/apify_client/_models.py" + }, + "538": { + "qualifiedName": "EncodeAndSignResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "539": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "540": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "541": { + "qualifiedName": "EnvVar", + "sourceFileName": "/src/apify_client/_models.py" + }, + "542": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "543": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "544": { + "qualifiedName": "value", + "sourceFileName": "/src/apify_client/_models.py" + }, + "545": { + "qualifiedName": "is_secret", + "sourceFileName": "/src/apify_client/_models.py" + }, + "546": { + "qualifiedName": "EnvVarRequest", + "sourceFileName": "/src/apify_client/_models.py" + }, + "547": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "548": { + "qualifiedName": "EnvVarResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "549": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "550": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "551": { + "qualifiedName": "ErrorDetail", + "sourceFileName": "/src/apify_client/_models.py" + }, + "552": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "553": { + "qualifiedName": "type", + "sourceFileName": "/src/apify_client/_models.py" + }, + "554": { + "qualifiedName": "message", + "sourceFileName": "/src/apify_client/_models.py" + }, + "555": { + "qualifiedName": "ErrorResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "556": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "557": { + "qualifiedName": "error", + "sourceFileName": "/src/apify_client/_models.py" + }, + "558": { + "qualifiedName": "EventData", + "sourceFileName": "/src/apify_client/_models.py" + }, + "559": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "560": { + "qualifiedName": "actor_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "561": { + "qualifiedName": "actor_run_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "562": { + "qualifiedName": "ExampleRunInput", + "sourceFileName": "/src/apify_client/_models.py" + }, + "563": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "564": { + "qualifiedName": "body", + "sourceFileName": "/src/apify_client/_models.py" + }, + "565": { + "qualifiedName": "content_type", + "sourceFileName": "/src/apify_client/_models.py" + }, + "566": { + "qualifiedName": "ExampleWebhookDispatch", + "sourceFileName": "/src/apify_client/_models.py" + }, + "567": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "568": { + "qualifiedName": "status", + "sourceFileName": "/src/apify_client/_models.py" + }, + "569": { + "qualifiedName": "finished_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "570": { + "qualifiedName": "FlatPricePerMonthActorPricingInfo", + "sourceFileName": "/src/apify_client/_models.py" + }, + "571": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "572": { + "qualifiedName": "pricing_model", + "sourceFileName": "/src/apify_client/_models.py" + }, + "573": { + "qualifiedName": "trial_minutes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "574": { + "qualifiedName": "price_per_unit_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "575": { + "qualifiedName": "FreeActorPricingInfo", + "sourceFileName": "/src/apify_client/_models.py" + }, + "576": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "577": { + "qualifiedName": "pricing_model", + "sourceFileName": "/src/apify_client/_models.py" + }, + "578": { + "qualifiedName": "HeadAndLockResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "579": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "580": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "581": { + "qualifiedName": "HeadRequest", + "sourceFileName": "/src/apify_client/_models.py" + }, + "582": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "583": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "584": { + "qualifiedName": "unique_key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "585": { + "qualifiedName": "url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "586": { + "qualifiedName": "method", + "sourceFileName": "/src/apify_client/_models.py" + }, + "587": { + "qualifiedName": "retry_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "588": { + "qualifiedName": "HeadResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "589": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "590": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "591": { + "qualifiedName": "InvalidItem", + "sourceFileName": "/src/apify_client/_models.py" + }, + "592": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "593": { + "qualifiedName": "item_position", + "sourceFileName": "/src/apify_client/_models.py" + }, + "594": { + "qualifiedName": "validation_errors", + "sourceFileName": "/src/apify_client/_models.py" + }, + "595": { + "qualifiedName": "KeyValueStore", + "sourceFileName": "/src/apify_client/_models.py" + }, + "596": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "597": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "598": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "599": { + "qualifiedName": "user_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "600": { + "qualifiedName": "username", + "sourceFileName": "/src/apify_client/_models.py" + }, + "601": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "602": { + "qualifiedName": "modified_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "603": { + "qualifiedName": "accessed_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "604": { + "qualifiedName": "act_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "605": { + "qualifiedName": "act_run_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "606": { + "qualifiedName": "console_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "607": { + "qualifiedName": "keys_public_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "608": { + "qualifiedName": "url_signing_secret_key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "609": { + "qualifiedName": "general_access", + "sourceFileName": "/src/apify_client/_models.py" + }, + "610": { + "qualifiedName": "stats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "611": { + "qualifiedName": "KeyValueStoreKey", + "sourceFileName": "/src/apify_client/_models.py" + }, + "612": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "613": { + "qualifiedName": "key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "614": { + "qualifiedName": "size", + "sourceFileName": "/src/apify_client/_models.py" + }, + "615": { + "qualifiedName": "record_public_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "616": { + "qualifiedName": "KeyValueStoreResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "617": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "618": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "619": { + "qualifiedName": "KeyValueStoreStats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "620": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "621": { + "qualifiedName": "read_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "622": { + "qualifiedName": "write_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "623": { + "qualifiedName": "delete_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "624": { + "qualifiedName": "list_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "625": { + "qualifiedName": "s3_storage_bytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "626": { + "qualifiedName": "KeyValueStores", + "sourceFileName": "/src/apify_client/_models.py" + }, + "627": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "628": { + "qualifiedName": "default", + "sourceFileName": "/src/apify_client/_models.py" + }, + "629": { + "qualifiedName": "Limits", + "sourceFileName": "/src/apify_client/_models.py" + }, + "630": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "631": { + "qualifiedName": "max_monthly_usage_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "632": { + "qualifiedName": "max_monthly_actor_compute_units", + "sourceFileName": "/src/apify_client/_models.py" + }, + "633": { + "qualifiedName": "max_monthly_external_data_transfer_gbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "634": { + "qualifiedName": "max_monthly_proxy_serps", + "sourceFileName": "/src/apify_client/_models.py" + }, + "635": { + "qualifiedName": "max_monthly_residential_proxy_gbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "636": { + "qualifiedName": "max_actor_memory_gbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "637": { + "qualifiedName": "max_actor_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "638": { + "qualifiedName": "max_actor_task_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "639": { + "qualifiedName": "max_concurrent_actor_jobs", + "sourceFileName": "/src/apify_client/_models.py" + }, + "640": { + "qualifiedName": "max_team_account_seat_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "641": { + "qualifiedName": "data_retention_days", + "sourceFileName": "/src/apify_client/_models.py" + }, + "642": { + "qualifiedName": "LimitsResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "643": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "644": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "645": { + "qualifiedName": "ListOfActorsInStoreResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "646": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "647": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "648": { + "qualifiedName": "ListOfActorsResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "649": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "650": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "651": { + "qualifiedName": "ListOfBuildsResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "652": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "653": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "654": { + "qualifiedName": "ListOfDatasetsResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "655": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "656": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "657": { + "qualifiedName": "ListOfEnvVars", + "sourceFileName": "/src/apify_client/_models.py" + }, + "658": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "659": { + "qualifiedName": "total", + "sourceFileName": "/src/apify_client/_models.py" + }, + "660": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "661": { + "qualifiedName": "ListOfEnvVarsResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "662": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "663": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "664": { + "qualifiedName": "ListOfKeyValueStoresResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "665": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "666": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "667": { + "qualifiedName": "ListOfKeys", + "sourceFileName": "/src/apify_client/_models.py" + }, + "668": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "669": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "670": { + "qualifiedName": "count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "671": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify_client/_models.py" + }, + "672": { + "qualifiedName": "exclusive_start_key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "673": { + "qualifiedName": "is_truncated", + "sourceFileName": "/src/apify_client/_models.py" + }, + "674": { + "qualifiedName": "next_exclusive_start_key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "675": { + "qualifiedName": "ListOfKeysResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "676": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "677": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "678": { + "qualifiedName": "ListOfRequestQueuesResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "679": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "680": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "681": { + "qualifiedName": "ListOfRequests", + "sourceFileName": "/src/apify_client/_models.py" + }, + "682": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "683": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "684": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify_client/_models.py" + }, + "685": { + "qualifiedName": "exclusive_start_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "686": { + "qualifiedName": "cursor", + "sourceFileName": "/src/apify_client/_models.py" + }, + "687": { + "qualifiedName": "next_cursor", + "sourceFileName": "/src/apify_client/_models.py" + }, + "688": { + "qualifiedName": "ListOfRequestsResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "689": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "690": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "691": { + "qualifiedName": "ListOfRunsResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "692": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "693": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "694": { + "qualifiedName": "ListOfSchedulesResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "695": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "696": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "697": { + "qualifiedName": "ListOfTasksResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "698": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "699": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "700": { + "qualifiedName": "ListOfVersions", + "sourceFileName": "/src/apify_client/_models.py" + }, + "701": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "702": { + "qualifiedName": "total", + "sourceFileName": "/src/apify_client/_models.py" + }, + "703": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "704": { + "qualifiedName": "ListOfVersionsResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "705": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "706": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "707": { + "qualifiedName": "ListOfWebhookDispatchesResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "708": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "709": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "710": { + "qualifiedName": "ListOfWebhooksResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "711": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "712": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "713": { + "qualifiedName": "LockedHeadRequest", + "sourceFileName": "/src/apify_client/_models.py" + }, + "714": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "715": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "716": { + "qualifiedName": "unique_key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "717": { + "qualifiedName": "url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "718": { + "qualifiedName": "method", + "sourceFileName": "/src/apify_client/_models.py" + }, + "719": { + "qualifiedName": "retry_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "720": { + "qualifiedName": "lock_expires_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "721": { + "qualifiedName": "LockedRequestQueueHead", + "sourceFileName": "/src/apify_client/_models.py" + }, + "722": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "723": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify_client/_models.py" + }, + "724": { + "qualifiedName": "queue_modified_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "725": { + "qualifiedName": "queue_has_locked_requests", + "sourceFileName": "/src/apify_client/_models.py" + }, + "726": { + "qualifiedName": "client_key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "727": { + "qualifiedName": "had_multiple_clients", + "sourceFileName": "/src/apify_client/_models.py" + }, + "728": { + "qualifiedName": "lock_secs", + "sourceFileName": "/src/apify_client/_models.py" + }, + "729": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "730": { + "qualifiedName": "Metamorph", + "sourceFileName": "/src/apify_client/_models.py" + }, + "731": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "732": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "733": { + "qualifiedName": "actor_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "734": { + "qualifiedName": "build_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "735": { + "qualifiedName": "input_key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "736": { + "qualifiedName": "MonthlyUsage", + "sourceFileName": "/src/apify_client/_models.py" + }, + "737": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "738": { + "qualifiedName": "usage_cycle", + "sourceFileName": "/src/apify_client/_models.py" + }, + "739": { + "qualifiedName": "monthly_service_usage", + "sourceFileName": "/src/apify_client/_models.py" + }, + "740": { + "qualifiedName": "daily_service_usages", + "sourceFileName": "/src/apify_client/_models.py" + }, + "741": { + "qualifiedName": "total_usage_credits_usd_before_volume_discount", + "sourceFileName": "/src/apify_client/_models.py" + }, + "742": { + "qualifiedName": "total_usage_credits_usd_after_volume_discount", + "sourceFileName": "/src/apify_client/_models.py" + }, + "743": { + "qualifiedName": "MonthlyUsageResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "744": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "745": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "746": { + "qualifiedName": "PaginationResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "747": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "748": { + "qualifiedName": "total", + "sourceFileName": "/src/apify_client/_models.py" + }, + "749": { + "qualifiedName": "offset", + "sourceFileName": "/src/apify_client/_models.py" + }, + "750": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify_client/_models.py" + }, + "751": { + "qualifiedName": "desc", + "sourceFileName": "/src/apify_client/_models.py" + }, + "752": { + "qualifiedName": "count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "753": { + "qualifiedName": "ListOfActors", + "sourceFileName": "/src/apify_client/_models.py" + }, + "754": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "755": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "756": { + "qualifiedName": "ListOfBuilds", + "sourceFileName": "/src/apify_client/_models.py" + }, + "757": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "758": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "759": { + "qualifiedName": "ListOfDatasets", + "sourceFileName": "/src/apify_client/_models.py" + }, + "760": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "761": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "762": { + "qualifiedName": "ListOfKeyValueStores", + "sourceFileName": "/src/apify_client/_models.py" + }, + "763": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "764": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "765": { + "qualifiedName": "ListOfRequestQueues", + "sourceFileName": "/src/apify_client/_models.py" + }, + "766": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "767": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "768": { + "qualifiedName": "ListOfRuns", + "sourceFileName": "/src/apify_client/_models.py" + }, + "769": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "770": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "771": { + "qualifiedName": "ListOfSchedules", + "sourceFileName": "/src/apify_client/_models.py" + }, + "772": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "773": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "774": { + "qualifiedName": "ListOfStoreActors", + "sourceFileName": "/src/apify_client/_models.py" + }, + "775": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "776": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "777": { + "qualifiedName": "ListOfTasks", + "sourceFileName": "/src/apify_client/_models.py" + }, + "778": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "779": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "780": { + "qualifiedName": "ListOfWebhookDispatches", + "sourceFileName": "/src/apify_client/_models.py" + }, + "781": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "782": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "783": { + "qualifiedName": "ListOfWebhooks", + "sourceFileName": "/src/apify_client/_models.py" + }, + "784": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "785": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "786": { + "qualifiedName": "PayPerEventActorPricingInfo", + "sourceFileName": "/src/apify_client/_models.py" + }, + "787": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "788": { + "qualifiedName": "pricing_model", + "sourceFileName": "/src/apify_client/_models.py" + }, + "789": { + "qualifiedName": "pricing_per_event", + "sourceFileName": "/src/apify_client/_models.py" + }, + "790": { + "qualifiedName": "minimal_max_total_charge_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "791": { + "qualifiedName": "Plan", + "sourceFileName": "/src/apify_client/_models.py" + }, + "792": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "793": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "794": { + "qualifiedName": "description", + "sourceFileName": "/src/apify_client/_models.py" + }, + "795": { + "qualifiedName": "is_enabled", + "sourceFileName": "/src/apify_client/_models.py" + }, + "796": { + "qualifiedName": "monthly_base_price_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "797": { + "qualifiedName": "monthly_usage_credits_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "798": { + "qualifiedName": "usage_discount_percent", + "sourceFileName": "/src/apify_client/_models.py" + }, + "799": { + "qualifiedName": "enabled_platform_features", + "sourceFileName": "/src/apify_client/_models.py" + }, + "800": { + "qualifiedName": "max_monthly_usage_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "801": { + "qualifiedName": "max_actor_memory_gbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "802": { + "qualifiedName": "max_monthly_actor_compute_units", + "sourceFileName": "/src/apify_client/_models.py" + }, + "803": { + "qualifiedName": "max_monthly_residential_proxy_gbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "804": { + "qualifiedName": "max_monthly_proxy_serps", + "sourceFileName": "/src/apify_client/_models.py" + }, + "805": { + "qualifiedName": "max_monthly_external_data_transfer_gbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "806": { + "qualifiedName": "max_actor_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "807": { + "qualifiedName": "max_actor_task_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "808": { + "qualifiedName": "data_retention_days", + "sourceFileName": "/src/apify_client/_models.py" + }, + "809": { + "qualifiedName": "available_proxy_groups", + "sourceFileName": "/src/apify_client/_models.py" + }, + "810": { + "qualifiedName": "team_account_seat_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "811": { + "qualifiedName": "support_level", + "sourceFileName": "/src/apify_client/_models.py" + }, + "812": { + "qualifiedName": "available_add_ons", + "sourceFileName": "/src/apify_client/_models.py" + }, + "813": { + "qualifiedName": "PricePerDatasetItemActorPricingInfo", + "sourceFileName": "/src/apify_client/_models.py" + }, + "814": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "815": { + "qualifiedName": "pricing_model", + "sourceFileName": "/src/apify_client/_models.py" + }, + "816": { + "qualifiedName": "unit_name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "817": { + "qualifiedName": "price_per_unit_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "818": { + "qualifiedName": "PriceTiers", + "sourceFileName": "/src/apify_client/_models.py" + }, + "819": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "820": { + "qualifiedName": "quantity_above", + "sourceFileName": "/src/apify_client/_models.py" + }, + "821": { + "qualifiedName": "discount_percent", + "sourceFileName": "/src/apify_client/_models.py" + }, + "822": { + "qualifiedName": "tier_quantity", + "sourceFileName": "/src/apify_client/_models.py" + }, + "823": { + "qualifiedName": "unit_price_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "824": { + "qualifiedName": "price_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "825": { + "qualifiedName": "PricingPerEvent", + "sourceFileName": "/src/apify_client/_models.py" + }, + "826": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "827": { + "qualifiedName": "actor_charge_events", + "sourceFileName": "/src/apify_client/_models.py" + }, + "828": { + "qualifiedName": "PrivateUserDataResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "829": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "830": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "831": { + "qualifiedName": "Profile", + "sourceFileName": "/src/apify_client/_models.py" + }, + "832": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "833": { + "qualifiedName": "bio", + "sourceFileName": "/src/apify_client/_models.py" + }, + "834": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "835": { + "qualifiedName": "picture_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "836": { + "qualifiedName": "github_username", + "sourceFileName": "/src/apify_client/_models.py" + }, + "837": { + "qualifiedName": "website_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "838": { + "qualifiedName": "twitter_username", + "sourceFileName": "/src/apify_client/_models.py" + }, + "839": { + "qualifiedName": "ProlongRequestLockResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "840": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "841": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "842": { + "qualifiedName": "Proxy", + "sourceFileName": "/src/apify_client/_models.py" + }, + "843": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "844": { + "qualifiedName": "password", + "sourceFileName": "/src/apify_client/_models.py" + }, + "845": { + "qualifiedName": "groups", + "sourceFileName": "/src/apify_client/_models.py" + }, + "846": { + "qualifiedName": "ProxyGroup", + "sourceFileName": "/src/apify_client/_models.py" + }, + "847": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "848": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "849": { + "qualifiedName": "description", + "sourceFileName": "/src/apify_client/_models.py" + }, + "850": { + "qualifiedName": "available_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "851": { + "qualifiedName": "PublicUserDataResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "852": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "853": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "854": { + "qualifiedName": "PutItemResponseError", + "sourceFileName": "/src/apify_client/_models.py" + }, + "855": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "856": { + "qualifiedName": "error", + "sourceFileName": "/src/apify_client/_models.py" + }, + "857": { + "qualifiedName": "PutItemsRequest", + "sourceFileName": "/src/apify_client/_models.py" + }, + "858": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "859": { + "qualifiedName": "PutRecordRequest", + "sourceFileName": "/src/apify_client/_models.py" + }, + "860": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "861": { + "qualifiedName": "RecordResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "862": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "863": { + "qualifiedName": "RequestBase", + "sourceFileName": "/src/apify_client/_models.py" + }, + "864": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "865": { + "qualifiedName": "unique_key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "866": { + "qualifiedName": "url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "867": { + "qualifiedName": "method", + "sourceFileName": "/src/apify_client/_models.py" + }, + "868": { + "qualifiedName": "retry_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "869": { + "qualifiedName": "loaded_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "870": { + "qualifiedName": "payload", + "sourceFileName": "/src/apify_client/_models.py" + }, + "871": { + "qualifiedName": "headers", + "sourceFileName": "/src/apify_client/_models.py" + }, + "872": { + "qualifiedName": "user_data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "873": { + "qualifiedName": "no_retry", + "sourceFileName": "/src/apify_client/_models.py" + }, + "874": { + "qualifiedName": "error_messages", + "sourceFileName": "/src/apify_client/_models.py" + }, + "875": { + "qualifiedName": "handled_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "876": { + "qualifiedName": "Request", + "sourceFileName": "/src/apify_client/_models.py" + }, + "877": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "878": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "879": { + "qualifiedName": "RequestDraft", + "sourceFileName": "/src/apify_client/_models.py" + }, + "880": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "881": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "882": { + "qualifiedName": "unique_key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "883": { + "qualifiedName": "url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "884": { + "qualifiedName": "method", + "sourceFileName": "/src/apify_client/_models.py" + }, + "885": { + "qualifiedName": "RequestDraftDeleteById", + "sourceFileName": "/src/apify_client/_models.py" + }, + "886": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "887": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "888": { + "qualifiedName": "unique_key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "889": { + "qualifiedName": "RequestDraftDeleteByUniqueKey", + "sourceFileName": "/src/apify_client/_models.py" + }, + "890": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "891": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "892": { + "qualifiedName": "unique_key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "893": { + "qualifiedName": "RequestDraftDelete", + "sourceFileName": "/src/apify_client/_models.py" + }, + "894": { + "qualifiedName": "root", + "sourceFileName": "/src/apify_client/_models.py" + }, + "895": { + "qualifiedName": "RequestLockInfo", + "sourceFileName": "/src/apify_client/_models.py" + }, + "896": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "897": { + "qualifiedName": "lock_expires_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "898": { + "qualifiedName": "RequestQueue", + "sourceFileName": "/src/apify_client/_models.py" + }, + "899": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "900": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "901": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "902": { + "qualifiedName": "user_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "903": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "904": { + "qualifiedName": "modified_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "905": { + "qualifiedName": "accessed_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "906": { + "qualifiedName": "total_request_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "907": { + "qualifiedName": "handled_request_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "908": { + "qualifiedName": "pending_request_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "909": { + "qualifiedName": "had_multiple_clients", + "sourceFileName": "/src/apify_client/_models.py" + }, + "910": { + "qualifiedName": "console_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "911": { + "qualifiedName": "stats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "912": { + "qualifiedName": "general_access", + "sourceFileName": "/src/apify_client/_models.py" + }, + "913": { + "qualifiedName": "RequestQueueHead", + "sourceFileName": "/src/apify_client/_models.py" + }, + "914": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "915": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify_client/_models.py" + }, + "916": { + "qualifiedName": "queue_modified_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "917": { + "qualifiedName": "had_multiple_clients", + "sourceFileName": "/src/apify_client/_models.py" + }, + "918": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "919": { + "qualifiedName": "RequestQueueResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "920": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "921": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "922": { + "qualifiedName": "RequestQueueShort", + "sourceFileName": "/src/apify_client/_models.py" + }, + "923": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "924": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "925": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "926": { + "qualifiedName": "user_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "927": { + "qualifiedName": "username", + "sourceFileName": "/src/apify_client/_models.py" + }, + "928": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "929": { + "qualifiedName": "modified_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "930": { + "qualifiedName": "accessed_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "931": { + "qualifiedName": "expire_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "932": { + "qualifiedName": "total_request_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "933": { + "qualifiedName": "handled_request_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "934": { + "qualifiedName": "pending_request_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "935": { + "qualifiedName": "act_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "936": { + "qualifiedName": "act_run_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "937": { + "qualifiedName": "had_multiple_clients", + "sourceFileName": "/src/apify_client/_models.py" + }, + "938": { + "qualifiedName": "RequestQueueStats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "939": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "940": { + "qualifiedName": "delete_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "941": { + "qualifiedName": "head_item_read_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "942": { + "qualifiedName": "read_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "943": { + "qualifiedName": "storage_bytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "944": { + "qualifiedName": "write_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "945": { + "qualifiedName": "RequestQueues", + "sourceFileName": "/src/apify_client/_models.py" + }, + "946": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "947": { + "qualifiedName": "default", + "sourceFileName": "/src/apify_client/_models.py" + }, + "948": { + "qualifiedName": "RequestRegistration", + "sourceFileName": "/src/apify_client/_models.py" + }, + "949": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "950": { + "qualifiedName": "request_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "951": { + "qualifiedName": "was_already_present", + "sourceFileName": "/src/apify_client/_models.py" + }, + "952": { + "qualifiedName": "was_already_handled", + "sourceFileName": "/src/apify_client/_models.py" + }, + "953": { + "qualifiedName": "RequestResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "954": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "955": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "956": { + "qualifiedName": "RequestUserData", + "sourceFileName": "/src/apify_client/_models.py" + }, + "957": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "958": { + "qualifiedName": "Run", + "sourceFileName": "/src/apify_client/_models.py" + }, + "959": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "960": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "961": { + "qualifiedName": "act_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "962": { + "qualifiedName": "user_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "963": { + "qualifiedName": "actor_task_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "964": { + "qualifiedName": "started_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "965": { + "qualifiedName": "finished_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "966": { + "qualifiedName": "status", + "sourceFileName": "/src/apify_client/_models.py" + }, + "967": { + "qualifiedName": "status_message", + "sourceFileName": "/src/apify_client/_models.py" + }, + "968": { + "qualifiedName": "is_status_message_terminal", + "sourceFileName": "/src/apify_client/_models.py" + }, + "969": { + "qualifiedName": "meta", + "sourceFileName": "/src/apify_client/_models.py" + }, + "970": { + "qualifiedName": "pricing_info", + "sourceFileName": "/src/apify_client/_models.py" + }, + "971": { + "qualifiedName": "stats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "972": { + "qualifiedName": "charged_event_counts", + "sourceFileName": "/src/apify_client/_models.py" + }, + "973": { + "qualifiedName": "options", + "sourceFileName": "/src/apify_client/_models.py" + }, + "974": { + "qualifiedName": "build_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "975": { + "qualifiedName": "exit_code", + "sourceFileName": "/src/apify_client/_models.py" + }, + "976": { + "qualifiedName": "general_access", + "sourceFileName": "/src/apify_client/_models.py" + }, + "977": { + "qualifiedName": "default_key_value_store_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "978": { + "qualifiedName": "default_dataset_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "979": { + "qualifiedName": "default_request_queue_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "980": { + "qualifiedName": "storage_ids", + "sourceFileName": "/src/apify_client/_models.py" + }, + "981": { + "qualifiedName": "build_number", + "sourceFileName": "/src/apify_client/_models.py" + }, + "982": { + "qualifiedName": "container_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "983": { + "qualifiedName": "is_container_server_ready", + "sourceFileName": "/src/apify_client/_models.py" + }, + "984": { + "qualifiedName": "git_branch_name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "985": { + "qualifiedName": "usage", + "sourceFileName": "/src/apify_client/_models.py" + }, + "986": { + "qualifiedName": "usage_total_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "987": { + "qualifiedName": "usage_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "988": { + "qualifiedName": "metamorphs", + "sourceFileName": "/src/apify_client/_models.py" + }, + "989": { + "qualifiedName": "RunFailedErrorDetail", + "sourceFileName": "/src/apify_client/_models.py" + }, + "990": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "991": { + "qualifiedName": "type", + "sourceFileName": "/src/apify_client/_models.py" + }, + "992": { + "qualifiedName": "RunMeta", + "sourceFileName": "/src/apify_client/_models.py" + }, + "993": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "994": { + "qualifiedName": "origin", + "sourceFileName": "/src/apify_client/_models.py" + }, + "995": { + "qualifiedName": "client_ip", + "sourceFileName": "/src/apify_client/_models.py" + }, + "996": { + "qualifiedName": "user_agent", + "sourceFileName": "/src/apify_client/_models.py" + }, + "997": { + "qualifiedName": "schedule_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "998": { + "qualifiedName": "scheduled_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "999": { + "qualifiedName": "RunOptions", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1000": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1001": { + "qualifiedName": "build", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1002": { + "qualifiedName": "timeout_secs", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1003": { + "qualifiedName": "memory_mbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1004": { + "qualifiedName": "disk_mbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1005": { + "qualifiedName": "max_items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1006": { + "qualifiedName": "max_total_charge_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1007": { + "qualifiedName": "RunResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1008": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1009": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1010": { + "qualifiedName": "RunShort", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1011": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1012": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1013": { + "qualifiedName": "act_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1014": { + "qualifiedName": "actor_task_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1015": { + "qualifiedName": "status", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1016": { + "qualifiedName": "started_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1017": { + "qualifiedName": "finished_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1018": { + "qualifiedName": "build_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1019": { + "qualifiedName": "build_number", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1020": { + "qualifiedName": "meta", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1021": { + "qualifiedName": "usage_total_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1022": { + "qualifiedName": "default_key_value_store_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1023": { + "qualifiedName": "default_dataset_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1024": { + "qualifiedName": "default_request_queue_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1025": { + "qualifiedName": "RunStats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1026": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1027": { + "qualifiedName": "input_body_len", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1028": { + "qualifiedName": "migration_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1029": { + "qualifiedName": "reboot_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1030": { + "qualifiedName": "restart_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1031": { + "qualifiedName": "resurrect_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1032": { + "qualifiedName": "mem_avg_bytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1033": { + "qualifiedName": "mem_max_bytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1034": { + "qualifiedName": "mem_current_bytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1035": { + "qualifiedName": "cpu_avg_usage", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1036": { + "qualifiedName": "cpu_max_usage", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1037": { + "qualifiedName": "cpu_current_usage", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1038": { + "qualifiedName": "net_rx_bytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1039": { + "qualifiedName": "net_tx_bytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1040": { + "qualifiedName": "duration_millis", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1041": { + "qualifiedName": "run_time_secs", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1042": { + "qualifiedName": "metamorph", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1043": { + "qualifiedName": "compute_units", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1044": { + "qualifiedName": "RunTimeoutExceededErrorDetail", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1045": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1046": { + "qualifiedName": "type", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1047": { + "qualifiedName": "RunUsage", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1048": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1049": { + "qualifiedName": "actor_compute_units", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1050": { + "qualifiedName": "dataset_reads", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1051": { + "qualifiedName": "dataset_writes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1052": { + "qualifiedName": "key_value_store_reads", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1053": { + "qualifiedName": "key_value_store_writes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1054": { + "qualifiedName": "key_value_store_lists", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1055": { + "qualifiedName": "request_queue_reads", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1056": { + "qualifiedName": "request_queue_writes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1057": { + "qualifiedName": "data_transfer_internal_gbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1058": { + "qualifiedName": "data_transfer_external_gbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1059": { + "qualifiedName": "proxy_residential_transfer_gbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1060": { + "qualifiedName": "proxy_serps", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1061": { + "qualifiedName": "RunUsageUsd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1062": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1063": { + "qualifiedName": "actor_compute_units", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1064": { + "qualifiedName": "dataset_reads", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1065": { + "qualifiedName": "dataset_writes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1066": { + "qualifiedName": "key_value_store_reads", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1067": { + "qualifiedName": "key_value_store_writes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1068": { + "qualifiedName": "key_value_store_lists", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1069": { + "qualifiedName": "request_queue_reads", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1070": { + "qualifiedName": "request_queue_writes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1071": { + "qualifiedName": "data_transfer_internal_gbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1072": { + "qualifiedName": "data_transfer_external_gbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1073": { + "qualifiedName": "proxy_residential_transfer_gbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1074": { + "qualifiedName": "proxy_serps", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1075": { + "qualifiedName": "ScheduleActionRunActor", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1076": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1077": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1078": { + "qualifiedName": "type", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1079": { + "qualifiedName": "actor_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1080": { + "qualifiedName": "run_input", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1081": { + "qualifiedName": "run_options", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1082": { + "qualifiedName": "ScheduleActionRunActorTask", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1083": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1084": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1085": { + "qualifiedName": "type", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1086": { + "qualifiedName": "actor_task_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1087": { + "qualifiedName": "input", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1088": { + "qualifiedName": "ScheduleActionRunInput", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1089": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1090": { + "qualifiedName": "body", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1091": { + "qualifiedName": "content_type", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1092": { + "qualifiedName": "ScheduleActionShortRunActor", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1093": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1094": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1095": { + "qualifiedName": "type", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1096": { + "qualifiedName": "actor_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1097": { + "qualifiedName": "ScheduleActionShortRunActorTask", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1098": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1099": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1100": { + "qualifiedName": "type", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1101": { + "qualifiedName": "actor_task_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1102": { + "qualifiedName": "ScheduleBase", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1103": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1104": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1105": { + "qualifiedName": "user_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1106": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1107": { + "qualifiedName": "cron_expression", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1108": { + "qualifiedName": "timezone", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1109": { + "qualifiedName": "is_enabled", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1110": { + "qualifiedName": "is_exclusive", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1111": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1112": { + "qualifiedName": "modified_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1113": { + "qualifiedName": "next_run_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1114": { + "qualifiedName": "last_run_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1115": { + "qualifiedName": "Schedule", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1116": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1117": { + "qualifiedName": "description", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1118": { + "qualifiedName": "title", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1119": { + "qualifiedName": "actions", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1120": { + "qualifiedName": "ScheduleCreate", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1121": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1122": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1123": { + "qualifiedName": "is_enabled", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1124": { + "qualifiedName": "is_exclusive", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1125": { + "qualifiedName": "cron_expression", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1126": { + "qualifiedName": "timezone", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1127": { + "qualifiedName": "description", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1128": { + "qualifiedName": "title", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1129": { + "qualifiedName": "actions", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1130": { + "qualifiedName": "ScheduleCreateActionRunActor", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1131": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1132": { + "qualifiedName": "type", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1133": { + "qualifiedName": "actor_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1134": { + "qualifiedName": "run_input", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1135": { + "qualifiedName": "run_options", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1136": { + "qualifiedName": "ScheduleCreateActionRunActorTask", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1137": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1138": { + "qualifiedName": "type", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1139": { + "qualifiedName": "actor_task_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1140": { + "qualifiedName": "input", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1141": { + "qualifiedName": "ScheduleInvoked", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1142": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1143": { + "qualifiedName": "message", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1144": { + "qualifiedName": "level", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1145": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1146": { + "qualifiedName": "ScheduleLogResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1147": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1148": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1149": { + "qualifiedName": "ScheduleResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1150": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1151": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1152": { + "qualifiedName": "ScheduleShort", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1153": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1154": { + "qualifiedName": "actions", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1155": { + "qualifiedName": "SchemaValidationErrorData", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1156": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1157": { + "qualifiedName": "invalid_items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1158": { + "qualifiedName": "SourceCodeFile", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1159": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1160": { + "qualifiedName": "format", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1161": { + "qualifiedName": "content", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1162": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1163": { + "qualifiedName": "SourceCodeFolder", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1164": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1165": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1166": { + "qualifiedName": "folder", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1167": { + "qualifiedName": "StorageIds", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1168": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1169": { + "qualifiedName": "datasets", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1170": { + "qualifiedName": "key_value_stores", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1171": { + "qualifiedName": "request_queues", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1172": { + "qualifiedName": "Storages", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1173": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1174": { + "qualifiedName": "dataset", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1175": { + "qualifiedName": "StoreListActor", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1176": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1177": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1178": { + "qualifiedName": "title", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1179": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1180": { + "qualifiedName": "username", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1181": { + "qualifiedName": "user_full_name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1182": { + "qualifiedName": "description", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1183": { + "qualifiedName": "categories", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1184": { + "qualifiedName": "notice", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1185": { + "qualifiedName": "picture_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1186": { + "qualifiedName": "user_picture_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1187": { + "qualifiedName": "url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1188": { + "qualifiedName": "stats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1189": { + "qualifiedName": "current_pricing_info", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1190": { + "qualifiedName": "is_white_listed_for_agentic_payment", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1191": { + "qualifiedName": "readme_summary", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1192": { + "qualifiedName": "TaggedBuildInfo", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1193": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1194": { + "qualifiedName": "build_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1195": { + "qualifiedName": "build_number", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1196": { + "qualifiedName": "finished_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1197": { + "qualifiedName": "Task", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1198": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1199": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1200": { + "qualifiedName": "user_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1201": { + "qualifiedName": "act_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1202": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1203": { + "qualifiedName": "username", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1204": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1205": { + "qualifiedName": "modified_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1206": { + "qualifiedName": "removed_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1207": { + "qualifiedName": "stats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1208": { + "qualifiedName": "options", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1209": { + "qualifiedName": "input", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1210": { + "qualifiedName": "title", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1211": { + "qualifiedName": "actor_standby", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1212": { + "qualifiedName": "standby_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1213": { + "qualifiedName": "TaskInput", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1214": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1215": { + "qualifiedName": "TaskOptions", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1216": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1217": { + "qualifiedName": "build", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1218": { + "qualifiedName": "timeout_secs", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1219": { + "qualifiedName": "memory_mbytes", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1220": { + "qualifiedName": "max_items", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1221": { + "qualifiedName": "max_total_charge_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1222": { + "qualifiedName": "restart_on_error", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1223": { + "qualifiedName": "TaskResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1224": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1225": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1226": { + "qualifiedName": "TaskShort", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1227": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1228": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1229": { + "qualifiedName": "user_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1230": { + "qualifiedName": "act_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1231": { + "qualifiedName": "act_name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1232": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1233": { + "qualifiedName": "username", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1234": { + "qualifiedName": "act_username", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1235": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1236": { + "qualifiedName": "modified_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1237": { + "qualifiedName": "stats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1238": { + "qualifiedName": "TaskStats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1239": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1240": { + "qualifiedName": "total_runs", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1241": { + "qualifiedName": "TestWebhookResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1242": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1243": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1244": { + "qualifiedName": "UnknownBuildTagError", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1245": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1246": { + "qualifiedName": "error", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1247": { + "qualifiedName": "UnknownBuildTagErrorDetail", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1248": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1249": { + "qualifiedName": "type", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1250": { + "qualifiedName": "UnlockRequestsResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1251": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1252": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1253": { + "qualifiedName": "UnlockRequestsResult", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1254": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1255": { + "qualifiedName": "unlocked_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1256": { + "qualifiedName": "UpdateActorRequest", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1257": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1258": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1259": { + "qualifiedName": "description", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1260": { + "qualifiedName": "is_public", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1261": { + "qualifiedName": "actor_permission_level", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1262": { + "qualifiedName": "seo_title", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1263": { + "qualifiedName": "seo_description", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1264": { + "qualifiedName": "title", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1265": { + "qualifiedName": "restart_on_error", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1266": { + "qualifiedName": "versions", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1267": { + "qualifiedName": "pricing_infos", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1268": { + "qualifiedName": "categories", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1269": { + "qualifiedName": "default_run_options", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1270": { + "qualifiedName": "tagged_builds", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1271": { + "qualifiedName": "actor_standby", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1272": { + "qualifiedName": "example_run_input", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1273": { + "qualifiedName": "is_deprecated", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1274": { + "qualifiedName": "UpdateDatasetRequest", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1275": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1276": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1277": { + "qualifiedName": "general_access", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1278": { + "qualifiedName": "UpdateLimitsRequest", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1279": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1280": { + "qualifiedName": "max_monthly_usage_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1281": { + "qualifiedName": "data_retention_days", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1282": { + "qualifiedName": "UpdateRequestQueueRequest", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1283": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1284": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1285": { + "qualifiedName": "general_access", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1286": { + "qualifiedName": "UpdateRequestResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1287": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1288": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1289": { + "qualifiedName": "UpdateRunRequest", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1290": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1291": { + "qualifiedName": "run_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1292": { + "qualifiedName": "status_message", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1293": { + "qualifiedName": "is_status_message_terminal", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1294": { + "qualifiedName": "general_access", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1295": { + "qualifiedName": "UpdateStoreRequest", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1296": { + "qualifiedName": "UpdateTaskRequest", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1297": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1298": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1299": { + "qualifiedName": "options", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1300": { + "qualifiedName": "input", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1301": { + "qualifiedName": "title", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1302": { + "qualifiedName": "actor_standby", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1303": { + "qualifiedName": "UsageCycle", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1304": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1305": { + "qualifiedName": "start_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1306": { + "qualifiedName": "end_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1307": { + "qualifiedName": "UsageItem", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1308": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1309": { + "qualifiedName": "quantity", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1310": { + "qualifiedName": "base_amount_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1311": { + "qualifiedName": "base_unit_price_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1312": { + "qualifiedName": "amount_after_volume_discount_usd", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1313": { + "qualifiedName": "price_tiers", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1314": { + "qualifiedName": "UserPrivateInfo", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1315": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1316": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1317": { + "qualifiedName": "username", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1318": { + "qualifiedName": "profile", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1319": { + "qualifiedName": "email", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1320": { + "qualifiedName": "proxy", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1321": { + "qualifiedName": "plan", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1322": { + "qualifiedName": "effective_platform_features", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1323": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1324": { + "qualifiedName": "is_paying", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1325": { + "qualifiedName": "UserPublicInfo", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1326": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1327": { + "qualifiedName": "username", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1328": { + "qualifiedName": "profile", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1329": { + "qualifiedName": "ValidationError", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1330": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1331": { + "qualifiedName": "instance_path", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1332": { + "qualifiedName": "schema_path", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1333": { + "qualifiedName": "keyword", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1334": { + "qualifiedName": "message", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1335": { + "qualifiedName": "params", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1336": { + "qualifiedName": "Version", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1337": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1338": { + "qualifiedName": "version_number", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1339": { + "qualifiedName": "source_type", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1340": { + "qualifiedName": "env_vars", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1341": { + "qualifiedName": "apply_env_vars_to_build", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1342": { + "qualifiedName": "build_tag", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1343": { + "qualifiedName": "source_files", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1344": { + "qualifiedName": "git_repo_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1345": { + "qualifiedName": "tarball_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1346": { + "qualifiedName": "github_gist_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1347": { + "qualifiedName": "VersionResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1348": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1349": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1350": { + "qualifiedName": "Webhook", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1351": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1352": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1353": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1354": { + "qualifiedName": "modified_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1355": { + "qualifiedName": "user_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1356": { + "qualifiedName": "is_ad_hoc", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1357": { + "qualifiedName": "should_interpolate_strings", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1358": { + "qualifiedName": "event_types", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1359": { + "qualifiedName": "condition", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1360": { + "qualifiedName": "ignore_ssl_errors", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1361": { + "qualifiedName": "do_not_retry", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1362": { + "qualifiedName": "request_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1363": { + "qualifiedName": "payload_template", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1364": { + "qualifiedName": "headers_template", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1365": { + "qualifiedName": "description", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1366": { + "qualifiedName": "last_dispatch", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1367": { + "qualifiedName": "stats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1368": { + "qualifiedName": "WebhookCondition", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1369": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1370": { + "qualifiedName": "actor_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1371": { + "qualifiedName": "actor_task_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1372": { + "qualifiedName": "actor_run_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1373": { + "qualifiedName": "WebhookCreate", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1374": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1375": { + "qualifiedName": "is_ad_hoc", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1376": { + "qualifiedName": "event_types", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1377": { + "qualifiedName": "condition", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1378": { + "qualifiedName": "idempotency_key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1379": { + "qualifiedName": "ignore_ssl_errors", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1380": { + "qualifiedName": "do_not_retry", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1381": { + "qualifiedName": "request_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1382": { + "qualifiedName": "payload_template", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1383": { + "qualifiedName": "headers_template", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1384": { + "qualifiedName": "description", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1385": { + "qualifiedName": "should_interpolate_strings", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1386": { + "qualifiedName": "WebhookDispatch", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1387": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1388": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1389": { + "qualifiedName": "user_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1390": { + "qualifiedName": "webhook_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1391": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1392": { + "qualifiedName": "status", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1393": { + "qualifiedName": "event_type", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1394": { + "qualifiedName": "event_data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1395": { + "qualifiedName": "calls", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1396": { + "qualifiedName": "WebhookDispatchResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1397": { + "qualifiedName": "WebhookRepresentation", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1398": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1399": { + "qualifiedName": "event_types", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1400": { + "qualifiedName": "request_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1401": { + "qualifiedName": "payload_template", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1402": { + "qualifiedName": "headers_template", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1403": { + "qualifiedName": "WebhookResponse", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1404": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1405": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1406": { + "qualifiedName": "WebhookShort", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1407": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1408": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1409": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1410": { + "qualifiedName": "modified_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1411": { + "qualifiedName": "user_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1412": { + "qualifiedName": "is_ad_hoc", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1413": { + "qualifiedName": "should_interpolate_strings", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1414": { + "qualifiedName": "event_types", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1415": { + "qualifiedName": "condition", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1416": { + "qualifiedName": "ignore_ssl_errors", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1417": { + "qualifiedName": "do_not_retry", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1418": { + "qualifiedName": "request_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1419": { + "qualifiedName": "last_dispatch", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1420": { + "qualifiedName": "stats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1421": { + "qualifiedName": "WebhookStats", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1422": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1423": { + "qualifiedName": "total_dispatches", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1424": { + "qualifiedName": "WebhookUpdate", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1425": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1426": { + "qualifiedName": "is_ad_hoc", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1427": { + "qualifiedName": "event_types", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1428": { + "qualifiedName": "condition", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1429": { + "qualifiedName": "ignore_ssl_errors", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1430": { + "qualifiedName": "do_not_retry", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1431": { + "qualifiedName": "request_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1432": { + "qualifiedName": "payload_template", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1433": { + "qualifiedName": "headers_template", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1434": { + "qualifiedName": "description", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1435": { + "qualifiedName": "should_interpolate_strings", + "sourceFileName": "/src/apify_client/_models.py" + }, + "1436": { + "qualifiedName": "ApifyClient", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1437": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1449": { + "qualifiedName": "with_custom_http_client", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1455": { + "qualifiedName": "token", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1456": { + "qualifiedName": "http_client", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1457": { + "qualifiedName": "actor", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1460": { + "qualifiedName": "actors", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1462": { + "qualifiedName": "build", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1465": { + "qualifiedName": "builds", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1467": { + "qualifiedName": "run", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1470": { + "qualifiedName": "runs", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1472": { + "qualifiedName": "dataset", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1475": { + "qualifiedName": "datasets", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1477": { + "qualifiedName": "key_value_store", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1480": { + "qualifiedName": "key_value_stores", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1482": { + "qualifiedName": "request_queue", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1486": { + "qualifiedName": "request_queues", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1488": { + "qualifiedName": "webhook", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1491": { + "qualifiedName": "webhooks", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1493": { + "qualifiedName": "webhook_dispatch", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1496": { + "qualifiedName": "webhook_dispatches", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1498": { + "qualifiedName": "schedule", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1501": { + "qualifiedName": "schedules", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1503": { + "qualifiedName": "log", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1506": { + "qualifiedName": "task", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1509": { + "qualifiedName": "tasks", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1511": { + "qualifiedName": "user", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1514": { + "qualifiedName": "store", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1516": { + "qualifiedName": "ApifyClientAsync", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1517": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1529": { + "qualifiedName": "with_custom_http_client", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1535": { + "qualifiedName": "token", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1536": { + "qualifiedName": "http_client", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1537": { + "qualifiedName": "actor", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1540": { + "qualifiedName": "actors", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1542": { + "qualifiedName": "build", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1545": { + "qualifiedName": "builds", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1547": { + "qualifiedName": "run", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1550": { + "qualifiedName": "runs", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1552": { + "qualifiedName": "dataset", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1555": { + "qualifiedName": "datasets", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1557": { + "qualifiedName": "key_value_store", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1560": { + "qualifiedName": "key_value_stores", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1562": { + "qualifiedName": "request_queue", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1566": { + "qualifiedName": "request_queues", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1568": { + "qualifiedName": "webhook", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1571": { + "qualifiedName": "webhooks", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1573": { + "qualifiedName": "webhook_dispatch", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1576": { + "qualifiedName": "webhook_dispatches", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1578": { + "qualifiedName": "schedule", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1581": { + "qualifiedName": "schedules", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1583": { + "qualifiedName": "log", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1586": { + "qualifiedName": "task", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1589": { + "qualifiedName": "tasks", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1591": { + "qualifiedName": "user", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1594": { + "qualifiedName": "store", + "sourceFileName": "/src/apify_client/_apify_client.py" + }, + "1596": { + "qualifiedName": "__version__", + "sourceFileName": "/src/apify_client/__init__.py" + }, + "1597": { + "qualifiedName": "logger_name", + "sourceFileName": "/src/apify_client/_logging.py" + }, + "1598": { + "qualifiedName": "logger", + "sourceFileName": "/src/apify_client/_logging.py" + }, + "1599": { + "qualifiedName": "LogContext", + "sourceFileName": "/src/apify_client/_logging.py" + }, + "1600": { + "qualifiedName": "attempt", + "sourceFileName": "/src/apify_client/_logging.py" + }, + "1601": { + "qualifiedName": "client_method", + "sourceFileName": "/src/apify_client/_logging.py" + }, + "1602": { + "qualifiedName": "method", + "sourceFileName": "/src/apify_client/_logging.py" + }, + "1603": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_logging.py" + }, + "1604": { + "qualifiedName": "url", + "sourceFileName": "/src/apify_client/_logging.py" + }, + "1605": { + "qualifiedName": "log_context", + "sourceFileName": "/src/apify_client/_logging.py" + }, + "1606": { + "qualifiedName": "WithLogDetailsClient", + "sourceFileName": "/src/apify_client/_logging.py" + }, + "1607": { + "qualifiedName": "__new__", + "sourceFileName": "/src/apify_client/_logging.py" + }, + "1612": { + "qualifiedName": "RedirectLogFormatter", + "sourceFileName": "/src/apify_client/_logging.py" + }, + "1613": { + "qualifiedName": "format", + "sourceFileName": "/src/apify_client/_logging.py" + }, + "1616": { + "qualifiedName": "create_redirect_logger", + "sourceFileName": "/src/apify_client/_logging.py" + }, + "1619": { + "qualifiedName": "_ContextInjectingFilter", + "sourceFileName": "/src/apify_client/_logging.py" + }, + "1620": { + "qualifiedName": "filter", + "sourceFileName": "/src/apify_client/_logging.py" + }, + "1623": { + "qualifiedName": "T", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "1624": { + "qualifiedName": "to_seconds", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "1628": { + "qualifiedName": "catch_not_found_or_throw", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "1631": { + "qualifiedName": "catch_not_found_for_resource_or_throw", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "1635": { + "qualifiedName": "encode_key_value_store_record_value", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "1639": { + "qualifiedName": "is_retryable_error", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "1642": { + "qualifiedName": "to_safe_id", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "1645": { + "qualifiedName": "response_to_dict", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "1648": { + "qualifiedName": "response_to_list", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "1651": { + "qualifiedName": "encode_base62", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "1654": { + "qualifiedName": "create_hmac_signature", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "1658": { + "qualifiedName": "create_storage_content_signature", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "1664": { + "qualifiedName": "check_custom_headers", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "1668": { + "qualifiedName": "encode_webhooks_to_base64", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "1671": { + "qualifiedName": "StatusMessageWatcherBase", + "sourceFileName": "/src/apify_client/_status_message_watcher.py" + }, + "1672": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_status_message_watcher.py" + }, + "1676": { + "qualifiedName": "StatusMessageWatcherAsync", + "sourceFileName": "/src/apify_client/_status_message_watcher.py" + }, + "1677": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_status_message_watcher.py" + }, + "1682": { + "qualifiedName": "start", + "sourceFileName": "/src/apify_client/_status_message_watcher.py" + }, + "1684": { + "qualifiedName": "stop", + "sourceFileName": "/src/apify_client/_status_message_watcher.py" + }, + "1686": { + "qualifiedName": "__aenter__", + "sourceFileName": "/src/apify_client/_status_message_watcher.py" + }, + "1688": { + "qualifiedName": "__aexit__", + "sourceFileName": "/src/apify_client/_status_message_watcher.py" + }, + "1693": { + "qualifiedName": "StatusMessageWatcher", + "sourceFileName": "/src/apify_client/_status_message_watcher.py" + }, + "1694": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_status_message_watcher.py" + }, + "1699": { + "qualifiedName": "start", + "sourceFileName": "/src/apify_client/_status_message_watcher.py" + }, + "1701": { + "qualifiedName": "stop", + "sourceFileName": "/src/apify_client/_status_message_watcher.py" + }, + "1703": { + "qualifiedName": "__enter__", + "sourceFileName": "/src/apify_client/_status_message_watcher.py" + }, + "1705": { + "qualifiedName": "__exit__", + "sourceFileName": "/src/apify_client/_status_message_watcher.py" + }, + "1710": { + "qualifiedName": "ClientRegistry", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1711": { + "qualifiedName": "actor_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1712": { + "qualifiedName": "actor_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1713": { + "qualifiedName": "actor_env_var_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1714": { + "qualifiedName": "actor_env_var_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1715": { + "qualifiedName": "actor_version_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1716": { + "qualifiedName": "actor_version_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1717": { + "qualifiedName": "build_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1718": { + "qualifiedName": "build_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1719": { + "qualifiedName": "dataset_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1720": { + "qualifiedName": "dataset_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1721": { + "qualifiedName": "key_value_store_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1722": { + "qualifiedName": "key_value_store_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1723": { + "qualifiedName": "log_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1724": { + "qualifiedName": "request_queue_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1725": { + "qualifiedName": "request_queue_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1726": { + "qualifiedName": "run_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1727": { + "qualifiedName": "run_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1728": { + "qualifiedName": "schedule_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1729": { + "qualifiedName": "schedule_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1730": { + "qualifiedName": "store_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1731": { + "qualifiedName": "task_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1732": { + "qualifiedName": "task_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1733": { + "qualifiedName": "user_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1734": { + "qualifiedName": "webhook_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1735": { + "qualifiedName": "webhook_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1736": { + "qualifiedName": "webhook_dispatch_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1737": { + "qualifiedName": "webhook_dispatch_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1738": { + "qualifiedName": "ClientRegistryAsync", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1739": { + "qualifiedName": "actor_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1740": { + "qualifiedName": "actor_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1741": { + "qualifiedName": "actor_env_var_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1742": { + "qualifiedName": "actor_env_var_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1743": { + "qualifiedName": "actor_version_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1744": { + "qualifiedName": "actor_version_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1745": { + "qualifiedName": "build_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1746": { + "qualifiedName": "build_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1747": { + "qualifiedName": "dataset_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1748": { + "qualifiedName": "dataset_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1749": { + "qualifiedName": "key_value_store_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1750": { + "qualifiedName": "key_value_store_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1751": { + "qualifiedName": "log_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1752": { + "qualifiedName": "request_queue_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1753": { + "qualifiedName": "request_queue_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1754": { + "qualifiedName": "run_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1755": { + "qualifiedName": "run_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1756": { + "qualifiedName": "schedule_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1757": { + "qualifiedName": "schedule_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1758": { + "qualifiedName": "store_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1759": { + "qualifiedName": "task_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1760": { + "qualifiedName": "task_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1761": { + "qualifiedName": "user_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1762": { + "qualifiedName": "webhook_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1763": { + "qualifiedName": "webhook_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1764": { + "qualifiedName": "webhook_dispatch_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1765": { + "qualifiedName": "webhook_dispatch_collection_client", + "sourceFileName": "/src/apify_client/_client_registry.py" + }, + "1766": { + "qualifiedName": "T", + "sourceFileName": "/src/apify_client/_pagination.py" + }, + "1767": { + "qualifiedName": "DEFAULT_CHUNK_SIZE", + "sourceFileName": "/src/apify_client/_pagination.py" + }, + "1768": { + "qualifiedName": "HasItems", + "sourceFileName": "/src/apify_client/_pagination.py" + }, + "1769": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_pagination.py" + }, + "1770": { + "qualifiedName": "get_items_iterator", + "sourceFileName": "/src/apify_client/_pagination.py" + }, + "1776": { + "qualifiedName": "get_items_iterator_async", + "sourceFileName": "/src/apify_client/_pagination.py" + }, + "1782": { + "qualifiedName": "get_cursor_iterator", + "sourceFileName": "/src/apify_client/_pagination.py" + }, + "1788": { + "qualifiedName": "get_cursor_iterator_async", + "sourceFileName": "/src/apify_client/_pagination.py" + }, + "1794": { + "qualifiedName": "ActorJobStatus", + "sourceFileName": "/src/apify_client/_literals.py" + }, + "1795": { + "qualifiedName": "ActorPermissionLevel", + "sourceFileName": "/src/apify_client/_literals.py" + }, + "1796": { + "qualifiedName": "ErrorType", + "sourceFileName": "/src/apify_client/_literals.py" + }, + "1797": { + "qualifiedName": "GeneralAccess", + "sourceFileName": "/src/apify_client/_literals.py" + }, + "1798": { + "qualifiedName": "HttpMethod", + "sourceFileName": "/src/apify_client/_literals.py" + }, + "1799": { + "qualifiedName": "RunOrigin", + "sourceFileName": "/src/apify_client/_literals.py" + }, + "1800": { + "qualifiedName": "SourceCodeFileFormat", + "sourceFileName": "/src/apify_client/_literals.py" + }, + "1801": { + "qualifiedName": "StorageOwnership", + "sourceFileName": "/src/apify_client/_literals.py" + }, + "1802": { + "qualifiedName": "VersionSourceType", + "sourceFileName": "/src/apify_client/_literals.py" + }, + "1803": { + "qualifiedName": "WebhookDispatchStatus", + "sourceFileName": "/src/apify_client/_literals.py" + }, + "1804": { + "qualifiedName": "WebhookEventType", + "sourceFileName": "/src/apify_client/_literals.py" + }, + "1805": { + "qualifiedName": "HttpResponse", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "1806": { + "qualifiedName": "status_code", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "1807": { + "qualifiedName": "text", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "1808": { + "qualifiedName": "content", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "1809": { + "qualifiedName": "headers", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "1810": { + "qualifiedName": "json", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "1812": { + "qualifiedName": "read", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "1814": { + "qualifiedName": "aread", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "1816": { + "qualifiedName": "close", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "1818": { + "qualifiedName": "aclose", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "1820": { + "qualifiedName": "iter_bytes", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "1822": { + "qualifiedName": "aiter_bytes", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "1824": { + "qualifiedName": "HttpClientBase", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "1825": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "1836": { + "qualifiedName": "HttpClient", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "1837": { + "qualifiedName": "call", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "1847": { + "qualifiedName": "HttpClientAsync", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "1848": { + "qualifiedName": "call", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "1858": { + "qualifiedName": "T", + "sourceFileName": "/src/apify_client/http_clients/_impit.py" + }, + "1859": { + "qualifiedName": "logger", + "sourceFileName": "/src/apify_client/http_clients/_impit.py" + }, + "1860": { + "qualifiedName": "ImpitHttpClient", + "sourceFileName": "/src/apify_client/http_clients/_impit.py" + }, + "1861": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/http_clients/_impit.py" + }, + "1872": { + "qualifiedName": "call", + "sourceFileName": "/src/apify_client/http_clients/_impit.py" + }, + "1882": { + "qualifiedName": "ImpitHttpClientAsync", + "sourceFileName": "/src/apify_client/http_clients/_impit.py" + }, + "1883": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/http_clients/_impit.py" + }, + "1894": { + "qualifiedName": "call", + "sourceFileName": "/src/apify_client/http_clients/_impit.py" + }, + "1904": { + "qualifiedName": "ScheduleClient", + "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" + }, + "1905": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" + }, + "1910": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" + }, + "1913": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" + }, + "1924": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" + }, + "1927": { + "qualifiedName": "get_log", + "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" + }, + "1930": { + "qualifiedName": "ScheduleClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" + }, + "1931": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" + }, + "1936": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" + }, + "1939": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" + }, + "1950": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" + }, + "1953": { + "qualifiedName": "get_log", + "sourceFileName": "/src/apify_client/_resource_clients/schedule.py" + }, + "1956": { + "qualifiedName": "UserClient", + "sourceFileName": "/src/apify_client/_resource_clients/user.py" + }, + "1957": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/user.py" + }, + "1962": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/user.py" + }, + "1965": { + "qualifiedName": "monthly_usage", + "sourceFileName": "/src/apify_client/_resource_clients/user.py" + }, + "1968": { + "qualifiedName": "limits", + "sourceFileName": "/src/apify_client/_resource_clients/user.py" + }, + "1971": { + "qualifiedName": "update_limits", + "sourceFileName": "/src/apify_client/_resource_clients/user.py" + }, + "1976": { + "qualifiedName": "UserClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/user.py" + }, + "1977": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/user.py" + }, + "1982": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/user.py" + }, + "1985": { + "qualifiedName": "monthly_usage", + "sourceFileName": "/src/apify_client/_resource_clients/user.py" + }, + "1988": { + "qualifiedName": "limits", + "sourceFileName": "/src/apify_client/_resource_clients/user.py" + }, + "1991": { + "qualifiedName": "update_limits", + "sourceFileName": "/src/apify_client/_resource_clients/user.py" + }, + "1996": { + "qualifiedName": "RequestQueueClient", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "1997": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2003": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2006": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2011": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2014": { + "qualifiedName": "list_head", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2018": { + "qualifiedName": "list_and_lock_head", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2023": { + "qualifiedName": "add_request", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2028": { + "qualifiedName": "get_request", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2032": { + "qualifiedName": "update_request", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2037": { + "qualifiedName": "delete_request", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2041": { + "qualifiedName": "prolong_request_lock", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2047": { + "qualifiedName": "delete_request_lock", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2052": { + "qualifiedName": "batch_add_requests", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2058": { + "qualifiedName": "batch_delete_requests", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2062": { + "qualifiedName": "list_requests", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2068": { + "qualifiedName": "iterate_requests", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2075": { + "qualifiedName": "unlock_requests", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2078": { + "qualifiedName": "RequestQueueClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2079": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2085": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2088": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2093": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2096": { + "qualifiedName": "list_head", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2100": { + "qualifiedName": "list_and_lock_head", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2105": { + "qualifiedName": "add_request", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2110": { + "qualifiedName": "get_request", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2114": { + "qualifiedName": "update_request", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2119": { + "qualifiedName": "delete_request", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2123": { + "qualifiedName": "prolong_request_lock", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2129": { + "qualifiedName": "delete_request_lock", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2134": { + "qualifiedName": "batch_add_requests", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2140": { + "qualifiedName": "batch_delete_requests", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2144": { + "qualifiedName": "list_requests", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2150": { + "qualifiedName": "iterate_requests", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2157": { + "qualifiedName": "unlock_requests", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue.py" + }, + "2160": { + "qualifiedName": "LogClient", + "sourceFileName": "/src/apify_client/_resource_clients/log.py" + }, + "2161": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/log.py" + }, + "2165": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/log.py" + }, + "2169": { + "qualifiedName": "get_as_bytes", + "sourceFileName": "/src/apify_client/_resource_clients/log.py" + }, + "2173": { + "qualifiedName": "stream", + "sourceFileName": "/src/apify_client/_resource_clients/log.py" + }, + "2177": { + "qualifiedName": "LogClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/log.py" + }, + "2178": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/log.py" + }, + "2182": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/log.py" + }, + "2186": { + "qualifiedName": "get_as_bytes", + "sourceFileName": "/src/apify_client/_resource_clients/log.py" + }, + "2190": { + "qualifiedName": "stream", + "sourceFileName": "/src/apify_client/_resource_clients/log.py" + }, + "2194": { + "qualifiedName": "ActorEnvVarCollectionClient", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" + }, + "2195": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" + }, + "2199": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" + }, + "2202": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" + }, + "2205": { + "qualifiedName": "create", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" + }, + "2211": { + "qualifiedName": "ActorEnvVarCollectionClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" + }, + "2212": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" + }, + "2216": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" + }, + "2219": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" + }, + "2222": { + "qualifiedName": "create", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var_collection.py" + }, + "2228": { + "qualifiedName": "WebhookDispatchCollectionClient", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py" + }, + "2229": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py" + }, + "2233": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py" + }, + "2239": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py" + }, + "2245": { + "qualifiedName": "WebhookDispatchCollectionClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py" + }, + "2246": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py" + }, + "2250": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py" + }, + "2256": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch_collection.py" + }, + "2262": { + "qualifiedName": "ActorCollectionClient", + "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" + }, + "2263": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" + }, + "2267": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" + }, + "2275": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" + }, + "2283": { + "qualifiedName": "create", + "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" + }, + "2308": { + "qualifiedName": "ActorCollectionClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" + }, + "2309": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" + }, + "2313": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" + }, + "2321": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" + }, + "2329": { + "qualifiedName": "create", + "sourceFileName": "/src/apify_client/_resource_clients/actor_collection.py" + }, + "2354": { + "qualifiedName": "WebhookDispatchClient", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch.py" + }, + "2355": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch.py" + }, + "2360": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch.py" + }, + "2363": { + "qualifiedName": "WebhookDispatchClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch.py" + }, + "2364": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch.py" + }, + "2369": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_dispatch.py" + }, + "2372": { + "qualifiedName": "KeyValueStoreCollectionClient", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" + }, + "2373": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" + }, + "2377": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" + }, + "2385": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" + }, + "2393": { + "qualifiedName": "get_or_create", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" + }, + "2398": { + "qualifiedName": "KeyValueStoreCollectionClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" + }, + "2399": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" + }, + "2403": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" + }, + "2411": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" + }, + "2419": { + "qualifiedName": "get_or_create", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store_collection.py" + }, + "2424": { + "qualifiedName": "ActorVersionClient", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" + }, + "2425": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" + }, + "2430": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" + }, + "2433": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" + }, + "2444": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" + }, + "2447": { + "qualifiedName": "env_vars", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" + }, + "2449": { + "qualifiedName": "env_var", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" + }, + "2452": { + "qualifiedName": "ActorVersionClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" + }, + "2453": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" + }, + "2458": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" + }, + "2461": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" + }, + "2472": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" + }, + "2475": { + "qualifiedName": "env_vars", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" + }, + "2477": { + "qualifiedName": "env_var", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version.py" + }, + "2480": { + "qualifiedName": "RequestQueueCollectionClient", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" + }, + "2481": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" + }, + "2485": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" + }, + "2493": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" + }, + "2501": { + "qualifiedName": "get_or_create", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" + }, + "2505": { + "qualifiedName": "RequestQueueCollectionClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" + }, + "2506": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" + }, + "2510": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" + }, + "2518": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" + }, + "2526": { + "qualifiedName": "get_or_create", + "sourceFileName": "/src/apify_client/_resource_clients/request_queue_collection.py" + }, + "2530": { + "qualifiedName": "TaskCollectionClient", + "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" + }, + "2531": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" + }, + "2535": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" + }, + "2541": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" + }, + "2547": { + "qualifiedName": "create", + "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" + }, + "2564": { + "qualifiedName": "TaskCollectionClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" + }, + "2565": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" + }, + "2569": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" + }, + "2575": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" + }, + "2581": { + "qualifiedName": "create", + "sourceFileName": "/src/apify_client/_resource_clients/task_collection.py" + }, + "2598": { + "qualifiedName": "StoreCollectionClient", + "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py" + }, + "2599": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py" + }, + "2603": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py" + }, + "2613": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py" + }, + "2623": { + "qualifiedName": "StoreCollectionClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py" + }, + "2624": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py" + }, + "2628": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py" + }, + "2638": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/store_collection.py" + }, + "2648": { + "qualifiedName": "TaskClient", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2649": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2654": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2657": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2673": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2676": { + "qualifiedName": "start", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2687": { + "qualifiedName": "call", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2698": { + "qualifiedName": "get_input", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2701": { + "qualifiedName": "update_input", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2705": { + "qualifiedName": "runs", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2707": { + "qualifiedName": "last_run", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2711": { + "qualifiedName": "webhooks", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2713": { + "qualifiedName": "TaskClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2714": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2719": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2722": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2738": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2741": { + "qualifiedName": "start", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2752": { + "qualifiedName": "call", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2763": { + "qualifiedName": "get_input", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2766": { + "qualifiedName": "update_input", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2770": { + "qualifiedName": "runs", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2772": { + "qualifiedName": "last_run", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2776": { + "qualifiedName": "webhooks", + "sourceFileName": "/src/apify_client/_resource_clients/task.py" + }, + "2778": { + "qualifiedName": "BuildCollectionClient", + "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py" + }, + "2779": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py" + }, + "2783": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py" + }, + "2789": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py" + }, + "2795": { + "qualifiedName": "BuildCollectionClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py" + }, + "2796": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py" + }, + "2800": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py" + }, + "2806": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/build_collection.py" + }, + "2812": { + "qualifiedName": "DatasetItemsPage", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2813": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2814": { + "qualifiedName": "total", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2815": { + "qualifiedName": "offset", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2816": { + "qualifiedName": "count", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2817": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2818": { + "qualifiedName": "desc", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2819": { + "qualifiedName": "DatasetClient", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2820": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2825": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2828": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2833": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2836": { + "qualifiedName": "list_items", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2851": { + "qualifiedName": "iterate_items", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2865": { + "qualifiedName": "get_items_as_bytes", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2885": { + "qualifiedName": "stream_items", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2904": { + "qualifiedName": "push_items", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2908": { + "qualifiedName": "get_statistics", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2911": { + "qualifiedName": "create_items_public_url", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2926": { + "qualifiedName": "DatasetClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2927": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2932": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2935": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2940": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2943": { + "qualifiedName": "list_items", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2958": { + "qualifiedName": "iterate_items", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2972": { + "qualifiedName": "get_items_as_bytes", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "2992": { + "qualifiedName": "stream_items", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "3011": { + "qualifiedName": "push_items", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "3015": { + "qualifiedName": "get_statistics", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "3018": { + "qualifiedName": "create_items_public_url", + "sourceFileName": "/src/apify_client/_resource_clients/dataset.py" + }, + "3033": { + "qualifiedName": "RunClient", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3034": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3039": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3042": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3048": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3051": { + "qualifiedName": "abort", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3055": { + "qualifiedName": "wait_for_finish", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3059": { + "qualifiedName": "metamorph", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3066": { + "qualifiedName": "resurrect", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3075": { + "qualifiedName": "reboot", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3078": { + "qualifiedName": "dataset", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3080": { + "qualifiedName": "key_value_store", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3082": { + "qualifiedName": "request_queue", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3084": { + "qualifiedName": "log", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3086": { + "qualifiedName": "get_streamed_log", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3091": { + "qualifiedName": "charge", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3097": { + "qualifiedName": "get_status_message_watcher", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3102": { + "qualifiedName": "RunClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3103": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3108": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3111": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3117": { + "qualifiedName": "abort", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3121": { + "qualifiedName": "wait_for_finish", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3125": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3128": { + "qualifiedName": "metamorph", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3135": { + "qualifiedName": "resurrect", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3144": { + "qualifiedName": "reboot", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3147": { + "qualifiedName": "dataset", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3149": { + "qualifiedName": "key_value_store", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3151": { + "qualifiedName": "request_queue", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3153": { + "qualifiedName": "log", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3155": { + "qualifiedName": "get_streamed_log", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3160": { + "qualifiedName": "charge", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3166": { + "qualifiedName": "get_status_message_watcher", + "sourceFileName": "/src/apify_client/_resource_clients/run.py" + }, + "3171": { + "qualifiedName": "BuildClient", + "sourceFileName": "/src/apify_client/_resource_clients/build.py" + }, + "3172": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/build.py" + }, + "3177": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/build.py" + }, + "3180": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/build.py" + }, + "3183": { + "qualifiedName": "abort", + "sourceFileName": "/src/apify_client/_resource_clients/build.py" + }, + "3186": { + "qualifiedName": "get_open_api_definition", + "sourceFileName": "/src/apify_client/_resource_clients/build.py" + }, + "3189": { + "qualifiedName": "wait_for_finish", + "sourceFileName": "/src/apify_client/_resource_clients/build.py" + }, + "3193": { + "qualifiedName": "log", + "sourceFileName": "/src/apify_client/_resource_clients/build.py" + }, + "3195": { + "qualifiedName": "BuildClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/build.py" + }, + "3196": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/build.py" + }, + "3201": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/build.py" + }, + "3204": { + "qualifiedName": "abort", + "sourceFileName": "/src/apify_client/_resource_clients/build.py" + }, + "3207": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/build.py" + }, + "3210": { + "qualifiedName": "get_open_api_definition", + "sourceFileName": "/src/apify_client/_resource_clients/build.py" + }, + "3213": { + "qualifiedName": "wait_for_finish", + "sourceFileName": "/src/apify_client/_resource_clients/build.py" + }, + "3217": { + "qualifiedName": "log", + "sourceFileName": "/src/apify_client/_resource_clients/build.py" + }, + "3219": { + "qualifiedName": "ScheduleCollectionClient", + "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" + }, + "3220": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" + }, + "3224": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" + }, + "3230": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" + }, + "3236": { + "qualifiedName": "create", + "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" + }, + "3247": { + "qualifiedName": "ScheduleCollectionClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" + }, + "3248": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" + }, + "3252": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" + }, + "3258": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" + }, + "3264": { + "qualifiedName": "create", + "sourceFileName": "/src/apify_client/_resource_clients/schedule_collection.py" + }, + "3275": { + "qualifiedName": "ActorVersionCollectionClient", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" + }, + "3276": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" + }, + "3280": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" + }, + "3283": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" + }, + "3286": { + "qualifiedName": "create", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" + }, + "3298": { + "qualifiedName": "ActorVersionCollectionClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" + }, + "3299": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" + }, + "3303": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" + }, + "3306": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" + }, + "3309": { + "qualifiedName": "create", + "sourceFileName": "/src/apify_client/_resource_clients/actor_version_collection.py" + }, + "3321": { + "qualifiedName": "DatasetCollectionClient", + "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" + }, + "3322": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" + }, + "3326": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" + }, + "3334": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" + }, + "3342": { + "qualifiedName": "get_or_create", + "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" + }, + "3347": { + "qualifiedName": "DatasetCollectionClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" + }, + "3348": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" + }, + "3352": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" + }, + "3360": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" + }, + "3368": { + "qualifiedName": "get_or_create", + "sourceFileName": "/src/apify_client/_resource_clients/dataset_collection.py" + }, + "3373": { + "qualifiedName": "ResourceClientBase", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3374": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3383": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3384": { + "qualifiedName": "ResourceClient", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3385": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3394": { + "qualifiedName": "ResourceClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3395": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3404": { + "qualifiedName": "ActorClient", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3405": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3410": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3413": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3441": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3444": { + "qualifiedName": "start", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3458": { + "qualifiedName": "call", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3473": { + "qualifiedName": "build", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3481": { + "qualifiedName": "builds", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3483": { + "qualifiedName": "runs", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3485": { + "qualifiedName": "default_build", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3489": { + "qualifiedName": "last_run", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3493": { + "qualifiedName": "versions", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3495": { + "qualifiedName": "version", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3498": { + "qualifiedName": "webhooks", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3500": { + "qualifiedName": "validate_input", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3506": { + "qualifiedName": "ActorClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3507": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3512": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3515": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3543": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3546": { + "qualifiedName": "start", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3560": { + "qualifiedName": "call", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3575": { + "qualifiedName": "build", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3583": { + "qualifiedName": "builds", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3585": { + "qualifiedName": "runs", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3587": { + "qualifiedName": "default_build", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3591": { + "qualifiedName": "last_run", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3595": { + "qualifiedName": "versions", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3597": { + "qualifiedName": "version", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3600": { + "qualifiedName": "webhooks", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3602": { + "qualifiedName": "validate_input", + "sourceFileName": "/src/apify_client/_resource_clients/actor.py" + }, + "3608": { + "qualifiedName": "KeyValueStoreClient", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3609": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3614": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3617": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3622": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3625": { + "qualifiedName": "list_keys", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3633": { + "qualifiedName": "iterate_keys", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3642": { + "qualifiedName": "get_record", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3647": { + "qualifiedName": "record_exists", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3651": { + "qualifiedName": "get_record_as_bytes", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3656": { + "qualifiedName": "stream_record", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3661": { + "qualifiedName": "set_record", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3667": { + "qualifiedName": "delete_record", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3671": { + "qualifiedName": "get_record_public_url", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3675": { + "qualifiedName": "create_keys_public_url", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3683": { + "qualifiedName": "KeyValueStoreClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3684": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3689": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3692": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3697": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3700": { + "qualifiedName": "list_keys", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3708": { + "qualifiedName": "iterate_keys", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3717": { + "qualifiedName": "get_record", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3722": { + "qualifiedName": "record_exists", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3726": { + "qualifiedName": "get_record_as_bytes", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3731": { + "qualifiedName": "stream_record", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3736": { + "qualifiedName": "set_record", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3742": { + "qualifiedName": "delete_record", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3746": { + "qualifiedName": "get_record_public_url", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3750": { + "qualifiedName": "create_keys_public_url", + "sourceFileName": "/src/apify_client/_resource_clients/key_value_store.py" + }, + "3758": { + "qualifiedName": "ActorEnvVarClient", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" + }, + "3759": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" + }, + "3764": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" + }, + "3767": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" + }, + "3773": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" + }, + "3776": { + "qualifiedName": "ActorEnvVarClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" + }, + "3777": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" + }, + "3782": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" + }, + "3785": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" + }, + "3791": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/actor_env_var.py" + }, + "3794": { + "qualifiedName": "WebhookCollectionClient", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" + }, + "3795": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" + }, + "3799": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" + }, + "3805": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" + }, + "3811": { + "qualifiedName": "create", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" + }, + "3825": { + "qualifiedName": "WebhookCollectionClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" + }, + "3826": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" + }, + "3830": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" + }, + "3836": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" + }, + "3842": { + "qualifiedName": "create", + "sourceFileName": "/src/apify_client/_resource_clients/webhook_collection.py" + }, + "3856": { + "qualifiedName": "WebhookClient", + "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" + }, + "3857": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" + }, + "3862": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" + }, + "3865": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" + }, + "3878": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" + }, + "3881": { + "qualifiedName": "test", + "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" + }, + "3884": { + "qualifiedName": "dispatches", + "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" + }, + "3886": { + "qualifiedName": "WebhookClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" + }, + "3887": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" + }, + "3892": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" + }, + "3895": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" + }, + "3908": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" + }, + "3911": { + "qualifiedName": "test", + "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" + }, + "3914": { + "qualifiedName": "dispatches", + "sourceFileName": "/src/apify_client/_resource_clients/webhook.py" + }, + "3916": { + "qualifiedName": "RunCollectionClient", + "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py" + }, + "3917": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py" + }, + "3921": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py" + }, + "3930": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py" + }, + "3939": { + "qualifiedName": "RunCollectionClientAsync", + "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py" + }, + "3940": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py" + }, + "3944": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py" + }, + "3953": { + "qualifiedName": "iterate", + "sourceFileName": "/src/apify_client/_resource_clients/run_collection.py" + }, + "3962": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3963": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3964": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3965": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3966": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3967": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3968": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3969": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3970": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3971": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3972": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3973": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3974": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3975": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3976": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3977": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3978": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3979": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3980": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3981": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3982": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3983": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3984": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3985": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3986": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3987": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3988": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3989": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3990": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3991": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3992": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3993": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3994": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3995": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3996": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3997": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3998": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "3999": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4000": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4001": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4002": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4003": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4004": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4005": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4006": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4007": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4008": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4009": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4010": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4011": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4012": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4013": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4014": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4015": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4016": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4017": { + "qualifiedName": "resource_id", + "sourceFileName": "/src/apify_client/_resource_clients/_resource_client.py" + }, + "4018": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "4019": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/http_clients/_base.py" + }, + "4020": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4021": { + "qualifiedName": "data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4022": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4023": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4024": { + "qualifiedName": "general_access", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4025": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4026": { + "qualifiedName": "user_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4027": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4028": { + "qualifiedName": "cron_expression", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4029": { + "qualifiedName": "timezone", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4030": { + "qualifiedName": "is_enabled", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4031": { + "qualifiedName": "is_exclusive", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4032": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4033": { + "qualifiedName": "modified_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4034": { + "qualifiedName": "next_run_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4035": { + "qualifiedName": "last_run_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4036": { + "qualifiedName": "id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4037": { + "qualifiedName": "user_id", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4038": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4039": { + "qualifiedName": "cron_expression", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4040": { + "qualifiedName": "timezone", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4041": { + "qualifiedName": "is_enabled", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4042": { + "qualifiedName": "is_exclusive", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4043": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4044": { + "qualifiedName": "modified_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4045": { + "qualifiedName": "next_run_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4046": { + "qualifiedName": "last_run_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4047": { + "qualifiedName": "message", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4048": { + "qualifiedName": "message", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4049": { + "qualifiedName": "message", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4050": { + "qualifiedName": "unique_key", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4051": { + "qualifiedName": "url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4052": { + "qualifiedName": "method", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4053": { + "qualifiedName": "retry_count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4054": { + "qualifiedName": "loaded_url", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4055": { + "qualifiedName": "payload", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4056": { + "qualifiedName": "headers", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4057": { + "qualifiedName": "user_data", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4058": { + "qualifiedName": "no_retry", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4059": { + "qualifiedName": "error_messages", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4060": { + "qualifiedName": "handled_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4061": { + "qualifiedName": "total", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4062": { + "qualifiedName": "offset", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4063": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4064": { + "qualifiedName": "desc", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4065": { + "qualifiedName": "count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4066": { + "qualifiedName": "total", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4067": { + "qualifiedName": "offset", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4068": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4069": { + "qualifiedName": "desc", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4070": { + "qualifiedName": "count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4071": { + "qualifiedName": "total", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4072": { + "qualifiedName": "offset", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4073": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4074": { + "qualifiedName": "desc", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4075": { + "qualifiedName": "count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4076": { + "qualifiedName": "total", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4077": { + "qualifiedName": "offset", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4078": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4079": { + "qualifiedName": "desc", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4080": { + "qualifiedName": "count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4081": { + "qualifiedName": "total", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4082": { + "qualifiedName": "offset", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4083": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4084": { + "qualifiedName": "desc", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4085": { + "qualifiedName": "count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4086": { + "qualifiedName": "total", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4087": { + "qualifiedName": "offset", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4088": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4089": { + "qualifiedName": "desc", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4090": { + "qualifiedName": "count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4091": { + "qualifiedName": "total", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4092": { + "qualifiedName": "offset", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4093": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4094": { + "qualifiedName": "desc", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4095": { + "qualifiedName": "count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4096": { + "qualifiedName": "total", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4097": { + "qualifiedName": "offset", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4098": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4099": { + "qualifiedName": "desc", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4100": { + "qualifiedName": "count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4101": { + "qualifiedName": "total", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4102": { + "qualifiedName": "offset", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4103": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4104": { + "qualifiedName": "desc", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4105": { + "qualifiedName": "count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4106": { + "qualifiedName": "total", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4107": { + "qualifiedName": "offset", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4108": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4109": { + "qualifiedName": "desc", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4110": { + "qualifiedName": "count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4111": { + "qualifiedName": "total", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4112": { + "qualifiedName": "offset", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4113": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4114": { + "qualifiedName": "desc", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4115": { + "qualifiedName": "count", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4116": { + "qualifiedName": "apify_margin_percentage", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4117": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4118": { + "qualifiedName": "started_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4119": { + "qualifiedName": "notified_about_future_change_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4120": { + "qualifiedName": "notified_about_change_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4121": { + "qualifiedName": "reason_for_change", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4122": { + "qualifiedName": "apify_margin_percentage", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4123": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4124": { + "qualifiedName": "started_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4125": { + "qualifiedName": "notified_about_future_change_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4126": { + "qualifiedName": "notified_about_change_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4127": { + "qualifiedName": "reason_for_change", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4128": { + "qualifiedName": "apify_margin_percentage", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4129": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4130": { + "qualifiedName": "started_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4131": { + "qualifiedName": "notified_about_future_change_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4132": { + "qualifiedName": "notified_about_change_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4133": { + "qualifiedName": "reason_for_change", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4134": { + "qualifiedName": "apify_margin_percentage", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4135": { + "qualifiedName": "created_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4136": { + "qualifiedName": "started_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4137": { + "qualifiedName": "notified_about_future_change_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4138": { + "qualifiedName": "notified_about_change_at", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4139": { + "qualifiedName": "reason_for_change", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4140": { + "qualifiedName": "name", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4141": { + "qualifiedName": "value", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4142": { + "qualifiedName": "is_secret", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4143": { + "qualifiedName": "model_config", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4144": { + "qualifiedName": "encoded", + "sourceFileName": "/src/apify_client/_models.py" + }, + "4145": { + "qualifiedName": "uniqueKey", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4146": { + "qualifiedName": "url", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4147": { + "qualifiedName": "method", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4148": { + "qualifiedName": "retryCount", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4149": { + "qualifiedName": "loadedUrl", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4150": { + "qualifiedName": "payload", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4151": { + "qualifiedName": "headers", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4152": { + "qualifiedName": "userData", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4153": { + "qualifiedName": "noRetry", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4154": { + "qualifiedName": "errorMessages", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4155": { + "qualifiedName": "handledAt", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4156": { + "qualifiedName": "unique_key", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4157": { + "qualifiedName": "url", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4158": { + "qualifiedName": "method", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4159": { + "qualifiedName": "retry_count", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4160": { + "qualifiedName": "loaded_url", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4161": { + "qualifiedName": "payload", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4162": { + "qualifiedName": "headers", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4163": { + "qualifiedName": "user_data", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4164": { + "qualifiedName": "no_retry", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4165": { + "qualifiedName": "error_messages", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4166": { + "qualifiedName": "handled_at", + "sourceFileName": "/src/apify_client/_typeddicts.py" + }, + "4167": { + "qualifiedName": "__new__", + "sourceFileName": "/src/apify_client/errors.py" + }, + "4168": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/errors.py" + }, + "4169": { + "qualifiedName": "__new__", + "sourceFileName": "/src/apify_client/errors.py" + }, + "4170": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/errors.py" + }, + "4171": { + "qualifiedName": "__new__", + "sourceFileName": "/src/apify_client/errors.py" + }, + "4172": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/errors.py" + }, + "4173": { + "qualifiedName": "__new__", + "sourceFileName": "/src/apify_client/errors.py" + }, + "4174": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/errors.py" + }, + "4175": { + "qualifiedName": "__new__", + "sourceFileName": "/src/apify_client/errors.py" + }, + "4176": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/errors.py" + }, + "4177": { + "qualifiedName": "__new__", + "sourceFileName": "/src/apify_client/errors.py" + }, + "4178": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/errors.py" + }, + "4179": { + "qualifiedName": "__new__", + "sourceFileName": "/src/apify_client/errors.py" + }, + "4180": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/errors.py" + } + }, + "overloads": [ + { + "args": [ + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", + "lineno": 34 + }, + "name": "td", + "type": "POSITIONAL", + "datatype": "None" + }, + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", + "lineno": 34 + }, + "name": "as_int", + "type": "KEYWORD_ONLY", + "datatype": "bool", + "default_value": "..." + } + ], + "return_type": "None", + "decorations": [ + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", + "lineno": 33 + }, + "name": "overload" + } + ], + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", + "lineno": 34 + }, + "name": "to_seconds", + "type": "function", + "parsedDocstring": { + "text": "" + } + }, + { + "args": [ + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", + "lineno": 36 + }, + "name": "td", + "type": "POSITIONAL", + "datatype": "timedelta" + } + ], + "return_type": "float", + "decorations": [ + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", + "lineno": 35 + }, + "name": "overload" + } + ], + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", + "lineno": 36 + }, + "name": "to_seconds", + "type": "function", + "parsedDocstring": { + "text": "" + } + }, + { + "args": [ + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", + "lineno": 38 + }, + "name": "td", + "type": "POSITIONAL", + "datatype": "timedelta" + }, + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", + "lineno": 38 + }, + "name": "as_int", + "type": "KEYWORD_ONLY", + "datatype": "Literal[True]" + } + ], + "return_type": "int", + "decorations": [ + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", + "lineno": 37 + }, + "name": "overload" + } + ], + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", + "lineno": 38 + }, + "name": "to_seconds", + "type": "function", + "parsedDocstring": { + "text": "" + } + }, + { + "args": [ + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", + "lineno": 40 + }, + "name": "td", + "type": "POSITIONAL", + "datatype": "timedelta" + }, + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", + "lineno": 40 + }, + "name": "as_int", + "type": "KEYWORD_ONLY", + "datatype": "Literal[False]" + } + ], + "return_type": "float", + "decorations": [ + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", + "lineno": 39 + }, + "name": "overload" + } + ], + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_utils.py", + "lineno": 40 + }, + "name": "to_seconds", + "type": "function", + "parsedDocstring": { + "text": "" + } + }, + { + "args": [ + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 103 + }, + "name": "callback", + "type": "POSITIONAL", + "datatype": "Callable[..., ListOfKeys]" + }, + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 105 + }, + "name": "cursor", + "type": "KEYWORD_ONLY", + "datatype": "str | None", + "default_value": "None" + }, + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 106 + }, + "name": "limit", + "type": "KEYWORD_ONLY", + "datatype": "int | None", + "default_value": "None" + }, + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 107 + }, + "name": "chunk_size", + "type": "KEYWORD_ONLY", + "datatype": "int | None", + "default_value": "None" + } + ], + "return_type": "Iterator[KeyValueStoreKey]", + "decorations": [ + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 101 + }, + "name": "overload" + } + ], + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 102 + }, + "name": "get_cursor_iterator", + "type": "function", + "parsedDocstring": { + "text": "" + } + }, + { + "args": [ + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 111 + }, + "name": "callback", + "type": "POSITIONAL", + "datatype": "Callable[..., ListOfRequests]" + }, + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 113 + }, + "name": "cursor", + "type": "KEYWORD_ONLY", + "datatype": "str | None", + "default_value": "None" + }, + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 114 + }, + "name": "limit", + "type": "KEYWORD_ONLY", + "datatype": "int | None", + "default_value": "None" + }, + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 115 + }, + "name": "chunk_size", + "type": "KEYWORD_ONLY", + "datatype": "int | None", + "default_value": "None" + } + ], + "return_type": "Iterator[Request]", + "decorations": [ + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 109 + }, + "name": "overload" + } + ], + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 110 + }, + "name": "get_cursor_iterator", + "type": "function", + "parsedDocstring": { + "text": "" + } + }, + { + "args": [ + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 158 + }, + "name": "callback", + "type": "POSITIONAL", + "datatype": "Callable[..., Awaitable[ListOfKeys]]" + }, + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 160 + }, + "name": "cursor", + "type": "KEYWORD_ONLY", + "datatype": "str | None", + "default_value": "None" + }, + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 161 + }, + "name": "limit", + "type": "KEYWORD_ONLY", + "datatype": "int | None", + "default_value": "None" + }, + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 162 + }, + "name": "chunk_size", + "type": "KEYWORD_ONLY", + "datatype": "int | None", + "default_value": "None" + } + ], + "return_type": "AsyncIterator[KeyValueStoreKey]", + "decorations": [ + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 156 + }, + "name": "overload" + } + ], + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 157 + }, + "name": "get_cursor_iterator_async", + "type": "function", + "parsedDocstring": { + "text": "" + } + }, + { + "args": [ + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 166 + }, + "name": "callback", + "type": "POSITIONAL", + "datatype": "Callable[..., Awaitable[ListOfRequests]]" + }, + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 168 + }, + "name": "cursor", + "type": "KEYWORD_ONLY", + "datatype": "str | None", + "default_value": "None" + }, + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 169 + }, + "name": "limit", + "type": "KEYWORD_ONLY", + "datatype": "int | None", + "default_value": "None" + }, + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 170 + }, + "name": "chunk_size", + "type": "KEYWORD_ONLY", + "datatype": "int | None", + "default_value": "None" + } + ], + "return_type": "AsyncIterator[Request]", + "decorations": [ + { + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 164 + }, + "name": "overload" + } + ], + "location": { + "filename": "REPO_ROOT_PLACEHOLDER/src/apify_client/_pagination.py", + "lineno": 165 + }, + "name": "get_cursor_iterator_async", + "type": "function", + "parsedDocstring": { + "text": "" + } + } + ] +} \ No newline at end of file diff --git a/website/versioned_sidebars/version-2.5-sidebars.json b/website/versioned_sidebars/version-2.5-sidebars.json index b90b80de..b666640d 100644 --- a/website/versioned_sidebars/version-2.5-sidebars.json +++ b/website/versioned_sidebars/version-2.5-sidebars.json @@ -1,45 +1,45 @@ { - "sidebar": [ - { - "type": "doc", - "id": "introduction/introduction" - }, - { - "type": "doc", - "id": "introduction/quick-start" - }, - { - "type": "category", - "label": "Concepts", - "collapsed": true, - "items": [ + "sidebar": [ { - "type": "autogenerated", - "dirName": "02_concepts" - } - ] - }, - { - "type": "category", - "label": "Guides", - "collapsed": true, - "items": [ + "type": "doc", + "id": "introduction/introduction" + }, { - "type": "autogenerated", - "dirName": "03_guides" - } - ] - }, - { - "type": "category", - "label": "Upgrading", - "collapsed": true, - "items": [ + "type": "doc", + "id": "introduction/quick-start" + }, + { + "type": "category", + "label": "Concepts", + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "02_concepts" + } + ] + }, + { + "type": "category", + "label": "Guides", + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "03_guides" + } + ] + }, { - "type": "autogenerated", - "dirName": "04_upgrading" + "type": "category", + "label": "Upgrading", + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "04_upgrading" + } + ] } - ] - } - ] + ] } diff --git a/website/versioned_sidebars/version-3.0-sidebars.json b/website/versioned_sidebars/version-3.0-sidebars.json new file mode 100644 index 00000000..b666640d --- /dev/null +++ b/website/versioned_sidebars/version-3.0-sidebars.json @@ -0,0 +1,45 @@ +{ + "sidebar": [ + { + "type": "doc", + "id": "introduction/introduction" + }, + { + "type": "doc", + "id": "introduction/quick-start" + }, + { + "type": "category", + "label": "Concepts", + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "02_concepts" + } + ] + }, + { + "type": "category", + "label": "Guides", + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "03_guides" + } + ] + }, + { + "type": "category", + "label": "Upgrading", + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "04_upgrading" + } + ] + } + ] +} diff --git a/website/versions.json b/website/versions.json index 1c02bab0..84e7ae1c 100644 --- a/website/versions.json +++ b/website/versions.json @@ -1,5 +1 @@ -[ - "2.5", - "1.12", - "0.6" -] +["3.0", "2.5", "1.12", "0.6"]