From 3c9e88377a00e48f87f9cc628fb25f5786a53d9e Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Fri, 27 Mar 2026 14:33:51 +0100 Subject: [PATCH 1/5] docs: add versioned docs for v0.6 (last zero-based release) Add the last zero-based version (0.6) to the Docusaurus docs versioning, including prose documentation, sidebar, and API reference generated from the actual v0.6.0 source code. Co-Authored-By: Claude Opus 4.6 (1M context) --- website/versioned_docs/version-0.6/.gitignore | 1 + .../version-0.6/01_introduction/index.mdx | 41 + .../01_introduction/quick-start.mdx | 51 + .../01_single_collection_clients.mdx | 46 + .../02_concepts/02_nested_clients.mdx | 21 + .../02_concepts/03_error_handling.mdx | 18 + .../version-0.6/02_concepts/04_retries.mdx | 15 + .../version-0.6/02_concepts/05_pagination.mdx | 18 + .../version-0.6/api-packages.json | 10 + .../version-0.6/api-typedoc.json | 23470 ++++++++++++++++ .../version-0.6-sidebars.json | 27 + website/versions.json | 2 +- 12 files changed, 23719 insertions(+), 1 deletion(-) create mode 100644 website/versioned_docs/version-0.6/.gitignore create mode 100644 website/versioned_docs/version-0.6/01_introduction/index.mdx create mode 100644 website/versioned_docs/version-0.6/01_introduction/quick-start.mdx create mode 100644 website/versioned_docs/version-0.6/02_concepts/01_single_collection_clients.mdx create mode 100644 website/versioned_docs/version-0.6/02_concepts/02_nested_clients.mdx create mode 100644 website/versioned_docs/version-0.6/02_concepts/03_error_handling.mdx create mode 100644 website/versioned_docs/version-0.6/02_concepts/04_retries.mdx create mode 100644 website/versioned_docs/version-0.6/02_concepts/05_pagination.mdx create mode 100644 website/versioned_docs/version-0.6/api-packages.json create mode 100644 website/versioned_docs/version-0.6/api-typedoc.json create mode 100644 website/versioned_sidebars/version-0.6-sidebars.json diff --git a/website/versioned_docs/version-0.6/.gitignore b/website/versioned_docs/version-0.6/.gitignore new file mode 100644 index 00000000..1a13c363 --- /dev/null +++ b/website/versioned_docs/version-0.6/.gitignore @@ -0,0 +1 @@ +changelog.md diff --git a/website/versioned_docs/version-0.6/01_introduction/index.mdx b/website/versioned_docs/version-0.6/01_introduction/index.mdx new file mode 100644 index 00000000..ef689b4e --- /dev/null +++ b/website/versioned_docs/version-0.6/01_introduction/index.mdx @@ -0,0 +1,41 @@ +--- +id: introduction +title: Overview +sidebar_label: Overview +slug: / +description: "The official Python library to access the Apify API, with automatic retries and convenience functions." +--- + +The [Apify client for Python](https://github.com/apify/apify-client-python) (`apify_client`) is the official library to access the [Apify REST API](https://docs.apify.com/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. + +## Prerequisites + +`apify-client` requires Python 3.7 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 + +```python +from apify_client import ApifyClient + +apify_client = ApifyClient('MY-APIFY-TOKEN') + +# Start an actor and wait for it to finish +actor_call = apify_client.actor('john-doe/my-cool-actor').call() + +# Fetch results from the actor's default dataset +dataset_items = apify_client.dataset(actor_call['defaultDatasetId']).list_items().items +``` + +> 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) for more details. diff --git a/website/versioned_docs/version-0.6/01_introduction/quick-start.mdx b/website/versioned_docs/version-0.6/01_introduction/quick-start.mdx new file mode 100644 index 00000000..50930818 --- /dev/null +++ b/website/versioned_docs/version-0.6/01_introduction/quick-start.mdx @@ -0,0 +1,51 @@ +--- +id: quick-start +title: Quick start +sidebar_label: Quick start +description: "Get started with the Apify client for Python." +--- + +## Installation + +```bash +pip install apify-client +``` + +## Authentication + +To use the Apify API, you need an API token. You can find your token in the [Integrations section](https://console.apify.com/account/integrations) of Apify Console. + +```python +from apify_client import ApifyClient + +apify_client = ApifyClient('MY-APIFY-TOKEN') +``` + +## Running an Actor + +The simplest way to run an Actor is to use the `call` method, which starts the Actor and waits for it to finish. + +```python +from apify_client import ApifyClient + +apify_client = ApifyClient('MY-APIFY-TOKEN') + +# Start an actor and wait for it to finish +actor_call = apify_client.actor('john-doe/my-cool-actor').call() + +# Fetch results from the actor's default dataset +dataset_items = apify_client.dataset(actor_call['defaultDatasetId']).list_items().items +``` + +## Working with datasets + +```python +# Get (or create, if it doesn't exist) a dataset with the name of my-dataset +my_dataset = apify_client.datasets().get_or_create(name='my-dataset') + +# Append items to the end of the dataset +apify_client.dataset(my_dataset['id']).push_items([{'foo': 1}, {'bar': 2}]) + +# List items in the dataset +items = apify_client.dataset(my_dataset['id']).list_items().items +``` diff --git a/website/versioned_docs/version-0.6/02_concepts/01_single_collection_clients.mdx b/website/versioned_docs/version-0.6/02_concepts/01_single_collection_clients.mdx new file mode 100644 index 00000000..917bdd8d --- /dev/null +++ b/website/versioned_docs/version-0.6/02_concepts/01_single_collection_clients.mdx @@ -0,0 +1,46 @@ +--- +title: Single and collection clients +--- + +The `ApifyClient` interface follows a generic pattern that is applicable to all of its components. By calling individual methods of `ApifyClient`, specific clients which target individual API resources are created. There are two types of those clients. A client for management of a single resource and a client for a collection of resources. + +### Collection clients + +```python +from apify_client import ApifyClient +apify_client = ApifyClient('MY-APIFY-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 +``` + +```python +# Collection clients do not require a parameter +dataset_collection_client = apify_client.datasets() +# Get (or create, if it doesn't exist) a dataset with the name of my-dataset +my_dataset = dataset_collection_client.get_or_create(name='my-dataset') +``` + +### Resource clients + +```python +# Resource clients accept an ID of the resource +actor_client = apify_client.actor('john-doe/my-actor') +# Fetch the john-doe/my-actor object from the API +my_actor = actor_client.get() +# Start the run of john-doe/my-actor and return the Run object +my_actor_run = actor_client.start() +``` + +```python +# Resource clients accept an ID of the resource +dataset_client = apify_client.dataset('john-doe/my-dataset') +# Append items to the end of john-doe/my-dataset +dataset_client.push_items([{'foo': 1}, {'bar': 2}]) +``` + +> The ID of the resource can be either the `id` of the said resource, or a combination of your `username/resource-name`. diff --git a/website/versioned_docs/version-0.6/02_concepts/02_nested_clients.mdx b/website/versioned_docs/version-0.6/02_concepts/02_nested_clients.mdx new file mode 100644 index 00000000..2553f828 --- /dev/null +++ b/website/versioned_docs/version-0.6/02_concepts/02_nested_clients.mdx @@ -0,0 +1,21 @@ +--- +title: Nested clients +--- + +Sometimes clients return other clients. That's to simplify working with nested collections, such as runs of a given actor. + +```python +from apify_client import ApifyClient +apify_client = ApifyClient('MY-APIFY-TOKEN') + +actor_client = apify_client.actor('john-doe/my-actor') +runs_client = actor_client.runs() +# List the last 10 runs of the john-doe/hello-world actor +actor_runs = runs_client.list(limit=10, desc=True).items + +# Select the last run of the john-doe/hello-world actor that finished +# with a SUCCEEDED status +last_succeeded_run_client = actor_client.last_run(status='SUCCEEDED') +# Fetch items from the run's dataset +dataset_items = last_succeeded_run_client.dataset().list_items().items +``` diff --git a/website/versioned_docs/version-0.6/02_concepts/03_error_handling.mdx b/website/versioned_docs/version-0.6/02_concepts/03_error_handling.mdx new file mode 100644 index 00000000..6135873d --- /dev/null +++ b/website/versioned_docs/version-0.6/02_concepts/03_error_handling.mdx @@ -0,0 +1,18 @@ +--- +title: Error handling +--- + +Based on the endpoint, the client automatically extracts the relevant data and returns it in the expected format. Date strings are automatically converted to `datetime.datetime` objects. + +For exceptions, we throw an `ApifyApiError`, which wraps the plain JSON errors returned by API and enriches them with other context for easier debugging. + +```python +from apify_client import ApifyClient + +apify_client = ApifyClient('MY-APIFY-TOKEN') + +try: + actor = apify_client.actor('non-existent-actor').get() +except Exception as e: + print(f'Error: {e}') +``` diff --git a/website/versioned_docs/version-0.6/02_concepts/04_retries.mdx b/website/versioned_docs/version-0.6/02_concepts/04_retries.mdx new file mode 100644 index 00000000..ae779731 --- /dev/null +++ b/website/versioned_docs/version-0.6/02_concepts/04_retries.mdx @@ -0,0 +1,15 @@ +--- +title: Retries with exponential backoff +--- + +Network communication sometimes fails. The client will automatically retry requests that failed due to a network error, an internal error of the Apify API (HTTP 500+) or rate limit error (HTTP 429). By default, it will retry up to 8 times. First retry will be attempted after ~500ms, second after ~1000ms and so on. You can configure those parameters using the `max_retries` and `min_delay_between_retries_millis` options of the `ApifyClient` constructor. + +```python +from apify_client import ApifyClient + +apify_client = ApifyClient( + 'MY-APIFY-TOKEN', + max_retries=8, + min_delay_between_retries_millis=500, +) +``` diff --git a/website/versioned_docs/version-0.6/02_concepts/05_pagination.mdx b/website/versioned_docs/version-0.6/02_concepts/05_pagination.mdx new file mode 100644 index 00000000..c9216240 --- /dev/null +++ b/website/versioned_docs/version-0.6/02_concepts/05_pagination.mdx @@ -0,0 +1,18 @@ +--- +title: Pagination +--- + +Most methods named `list` or `list_something` return a `ListPage` object, containing properties `items`, `total`, `offset`, `count` and `limit`. There are some exceptions though, like `list_keys` or `list_head` which paginate differently. The results you're looking for are always stored under `items` and you can use the `limit` property to get only a subset of results. Other properties can be available depending on the method. + +```python +from apify_client import ApifyClient + +apify_client = ApifyClient('MY-APIFY-TOKEN') + +# List first 10 actors +actors = apify_client.actors().list(limit=10) +print(f'Total actors: {actors.total}') +print(f'Returned: {actors.count}') +for actor in actors.items: + print(actor['name']) +``` diff --git a/website/versioned_docs/version-0.6/api-packages.json b/website/versioned_docs/version-0.6/api-packages.json new file mode 100644 index 00000000..32e716f8 --- /dev/null +++ b/website/versioned_docs/version-0.6/api-packages.json @@ -0,0 +1,10 @@ +[ + { + "entryPoints": { "index": { "label": "Index", "path": "src/apify_client" } }, + "packageRoot": "..", + "packagePath": ".", + "packageSlug": ".", + "packageName": "apify-client", + "packageVersion": "0.6.0" + } +] diff --git a/website/versioned_docs/version-0.6/api-typedoc.json b/website/versioned_docs/version-0.6/api-typedoc.json new file mode 100644 index 00000000..3cc3a954 --- /dev/null +++ b/website/versioned_docs/version-0.6/api-typedoc.json @@ -0,0 +1,23470 @@ +{ + "children": [ + { + "kind": 8, + "kindString": "Enumeration", + "children": [ + { + "kind": 16, + "kindString": "Enumeration Member", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor job initialized but not started yet" + } + ] + }, + "flags": {}, + "groups": [], + "id": 2, + "module": "consts", + "name": "READY", + "parsedDocstring": { + "text": "Actor job initialized but not started yet" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 8 + } + ], + "type": { + "type": "literal", + "value": "'READY'" + } + }, + { + "kind": 16, + "kindString": "Enumeration Member", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor job in progress" + } + ] + }, + "flags": {}, + "groups": [], + "id": 3, + "module": "consts", + "name": "RUNNING", + "parsedDocstring": { + "text": "Actor job in progress" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 10 + } + ], + "type": { + "type": "literal", + "value": "'RUNNING'" + } + }, + { + "kind": 16, + "kindString": "Enumeration Member", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor job finished successfully" + } + ] + }, + "flags": {}, + "groups": [], + "id": 4, + "module": "consts", + "name": "SUCCEEDED", + "parsedDocstring": { + "text": "Actor job finished successfully" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 12 + } + ], + "type": { + "type": "literal", + "value": "'SUCCEEDED'" + } + }, + { + "kind": 16, + "kindString": "Enumeration Member", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor job or build failed" + } + ] + }, + "flags": {}, + "groups": [], + "id": 5, + "module": "consts", + "name": "FAILED", + "parsedDocstring": { + "text": "Actor job or build failed" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 14 + } + ], + "type": { + "type": "literal", + "value": "'FAILED'" + } + }, + { + "kind": 16, + "kindString": "Enumeration Member", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor job currently timing out" + } + ] + }, + "flags": {}, + "groups": [], + "id": 6, + "module": "consts", + "name": "TIMING_OUT", + "parsedDocstring": { + "text": "Actor job currently timing out" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 16 + } + ], + "type": { + "type": "literal", + "value": "'TIMING-OUT'" + } + }, + { + "kind": 16, + "kindString": "Enumeration Member", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor job timed out" + } + ] + }, + "flags": {}, + "groups": [], + "id": 7, + "module": "consts", + "name": "TIMED_OUT", + "parsedDocstring": { + "text": "Actor job timed out" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 18 + } + ], + "type": { + "type": "literal", + "value": "'TIMED-OUT'" + } + }, + { + "kind": 16, + "kindString": "Enumeration Member", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor job currently being aborted by user" + } + ] + }, + "flags": {}, + "groups": [], + "id": 8, + "module": "consts", + "name": "ABORTING", + "parsedDocstring": { + "text": "Actor job currently being aborted by user" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 20 + } + ], + "type": { + "type": "literal", + "value": "'ABORTING'" + } + }, + { + "kind": 16, + "kindString": "Enumeration Member", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor job aborted by user" + } + ] + }, + "flags": {}, + "groups": [], + "id": 9, + "module": "consts", + "name": "ABORTED", + "parsedDocstring": { + "text": "Actor job aborted by user" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 22 + } + ], + "type": { + "type": "literal", + "value": "'ABORTED'" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Available statuses for actor jobs (runs or builds)." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 9, + 8, + 5, + 2, + 3, + 4, + 7, + 6 + ], + "title": "Enumeration members" + } + ], + "id": 1, + "module": "consts", + "name": "ActorJobStatus", + "parsedDocstring": { + "text": "Available statuses for actor jobs (runs or builds)." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 4 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 8, + "kindString": "Enumeration", + "children": [ + { + "kind": 16, + "kindString": "Enumeration Member", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor source code is comprised of multiple files" + } + ] + }, + "flags": {}, + "groups": [], + "id": 11, + "module": "consts", + "name": "SOURCE_FILES", + "parsedDocstring": { + "text": "Actor source code is comprised of multiple files" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 34 + } + ], + "type": { + "type": "literal", + "value": "'SOURCE_FILES'" + } + }, + { + "kind": 16, + "kindString": "Enumeration Member", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor source code is cloned from a Git repository" + } + ] + }, + "flags": {}, + "groups": [], + "id": 12, + "module": "consts", + "name": "GIT_REPO", + "parsedDocstring": { + "text": "Actor source code is cloned from a Git repository" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 36 + } + ], + "type": { + "type": "literal", + "value": "'GIT_REPO'" + } + }, + { + "kind": 16, + "kindString": "Enumeration Member", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor source code is downloaded using a tarball or Zip file" + } + ] + }, + "flags": {}, + "groups": [], + "id": 13, + "module": "consts", + "name": "TARBALL", + "parsedDocstring": { + "text": "Actor source code is downloaded using a tarball or Zip file" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 38 + } + ], + "type": { + "type": "literal", + "value": "'TARBALL'" + } + }, + { + "kind": 16, + "kindString": "Enumeration Member", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor source code is taken from a GitHub Gist" + } + ] + }, + "flags": {}, + "groups": [], + "id": 14, + "module": "consts", + "name": "GITHUB_GIST", + "parsedDocstring": { + "text": "Actor source code is taken from a GitHub Gist" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 40 + } + ], + "type": { + "type": "literal", + "value": "'GITHUB_GIST'" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Available source types for actors." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 12, + 14, + 11, + 13 + ], + "title": "Enumeration members" + } + ], + "id": 10, + "module": "consts", + "name": "ActorSourceType", + "parsedDocstring": { + "text": "Available source types for actors." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 30 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 8, + "kindString": "Enumeration", + "children": [ + { + "kind": 16, + "kindString": "Enumeration Member", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The actor run was created" + } + ] + }, + "flags": {}, + "groups": [], + "id": 16, + "module": "consts", + "name": "ACTOR_RUN_CREATED", + "parsedDocstring": { + "text": "The actor run was created" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 47 + } + ], + "type": { + "type": "literal", + "value": "'ACTOR.RUN.CREATED'" + } + }, + { + "kind": 16, + "kindString": "Enumeration Member", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The actor run has succeeded" + } + ] + }, + "flags": {}, + "groups": [], + "id": 17, + "module": "consts", + "name": "ACTOR_RUN_SUCCEEDED", + "parsedDocstring": { + "text": "The actor run has succeeded" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 49 + } + ], + "type": { + "type": "literal", + "value": "'ACTOR.RUN.SUCCEEDED'" + } + }, + { + "kind": 16, + "kindString": "Enumeration Member", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The actor run has failed" + } + ] + }, + "flags": {}, + "groups": [], + "id": 18, + "module": "consts", + "name": "ACTOR_RUN_FAILED", + "parsedDocstring": { + "text": "The actor run has failed" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 51 + } + ], + "type": { + "type": "literal", + "value": "'ACTOR.RUN.FAILED'" + } + }, + { + "kind": 16, + "kindString": "Enumeration Member", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The actor run has timed out" + } + ] + }, + "flags": {}, + "groups": [], + "id": 19, + "module": "consts", + "name": "ACTOR_RUN_TIMED_OUT", + "parsedDocstring": { + "text": "The actor run has timed out" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 53 + } + ], + "type": { + "type": "literal", + "value": "'ACTOR.RUN.TIMED_OUT'" + } + }, + { + "kind": 16, + "kindString": "Enumeration Member", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The actor run was aborted" + } + ] + }, + "flags": {}, + "groups": [], + "id": 20, + "module": "consts", + "name": "ACTOR_RUN_ABORTED", + "parsedDocstring": { + "text": "The actor run was aborted" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 55 + } + ], + "type": { + "type": "literal", + "value": "'ACTOR.RUN.ABORTED'" + } + }, + { + "kind": 16, + "kindString": "Enumeration Member", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The actor run was resurrected" + } + ] + }, + "flags": {}, + "groups": [], + "id": 21, + "module": "consts", + "name": "ACTOR_RUN_RESURRECTED", + "parsedDocstring": { + "text": "The actor run was resurrected" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 57 + } + ], + "type": { + "type": "literal", + "value": "'ACTOR.RUN.RESURRECTED'" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Events that can trigger a webhook." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 20, + 16, + 18, + 21, + 17, + 19 + ], + "title": "Enumeration members" + } + ], + "id": 15, + "module": "consts", + "name": "WebhookEventType", + "parsedDocstring": { + "text": "Events that can trigger a webhook." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/consts.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 43 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 22, + "module": "client", + "name": "DEFAULT_API_URL", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 29 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 23, + "module": "client", + "name": "API_VERSION", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 30 + } + ], + "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" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 25, + "module": "client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the Apify API Client.\n", + "args": { + "token": "The Apify API token", + "api_url": "The URL of the Apify API server to which to connect to. Defaults to https://api.apify.com", + "max_retries": "How many times to retry a failed request at most", + "min_delay_between_retries_millis": "How long will the client wait between retrying requests\n(increases exponentially from this value)" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 36 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the Apify API Client.\n" + } + ] + }, + "flags": {}, + "id": 26, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Apify API token" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": false + }, + "id": 27, + "kind": 32768, + "kindString": "Parameter", + "name": "token", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the Apify API server to which to connect to. Defaults to https://api.apify.com" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 28, + "kind": 32768, + "kindString": "Parameter", + "name": "api_url", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many times to retry a failed request at most" + } + ] + }, + "defaultValue": "8", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 29, + "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": "500", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 30, + "kind": 32768, + "kindString": "Parameter", + "name": "min_delay_between_retries_millis", + "type": { + "name": "int", + "type": "reference" + } + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single actor.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 31, + "module": "client", + "name": "actor", + "parsedDocstring": { + "text": "Retrieve the sub-client for manipulating a single actor.\n", + "args": { + "actor_id": "ID of the actor to be manipulated" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 74 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single actor.\n" + } + ] + }, + "flags": {}, + "id": 32, + "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": 33, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "ActorClient", + "type": "reference", + "target": "614" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating actors." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 34, + "module": "client", + "name": "actors", + "parsedDocstring": { + "text": "Retrieve the sub-client for manipulating actors." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 82 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating actors." + } + ] + }, + "flags": {}, + "id": 35, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "actors", + "parameters": [], + "type": { + "name": "ActorCollectionClient", + "type": "reference", + "target": "585" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single actor build.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 36, + "module": "client", + "name": "build", + "parsedDocstring": { + "text": "Retrieve the sub-client for manipulating a single actor build.\n", + "args": { + "build_id": "ID of the actor build to be manipulated" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 86 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single actor build.\n" + } + ] + }, + "flags": {}, + "id": 37, + "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": 38, + "kind": 32768, + "kindString": "Parameter", + "name": "build_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "BuildClient", + "type": "reference", + "target": "536" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple builds of a user." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 39, + "module": "client", + "name": "builds", + "parsedDocstring": { + "text": "Retrieve the sub-client for querying multiple builds of a user." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 94 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple builds of a user." + } + ] + }, + "flags": {}, + "id": 40, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "builds", + "parameters": [], + "type": { + "name": "BuildCollectionClient", + "type": "reference", + "target": "526" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single actor run.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 41, + "module": "client", + "name": "run", + "parsedDocstring": { + "text": "Retrieve the sub-client for manipulating a single actor run.\n", + "args": { + "run_id": "ID of the actor run to be manipulated" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 98 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single actor run.\n" + } + ] + }, + "flags": {}, + "id": 42, + "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": 43, + "kind": 32768, + "kindString": "Parameter", + "name": "run_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "RunClient", + "type": "reference", + "target": "316" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple actor runs of a user." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 44, + "module": "client", + "name": "runs", + "parsedDocstring": { + "text": "Retrieve the sub-client for querying multiple actor runs of a user." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 106 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple actor runs of a user." + } + ] + }, + "flags": {}, + "id": 45, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "runs", + "parameters": [], + "type": { + "name": "RunCollectionClient", + "type": "reference", + "target": "305" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single dataset.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 46, + "module": "client", + "name": "dataset", + "parsedDocstring": { + "text": "Retrieve the sub-client for manipulating a single dataset.\n", + "args": { + "dataset_id": "ID of the dataset to be manipulated" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 110 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single dataset.\n" + } + ] + }, + "flags": {}, + "id": 47, + "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": 48, + "kind": 32768, + "kindString": "Parameter", + "name": "dataset_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "DatasetClient", + "type": "reference", + "target": "455" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating datasets." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 49, + "module": "client", + "name": "datasets", + "parsedDocstring": { + "text": "Retrieve the sub-client for manipulating datasets." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 118 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating datasets." + } + ] + }, + "flags": {}, + "id": 50, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "datasets", + "parameters": [], + "type": { + "name": "DatasetCollectionClient", + "type": "reference", + "target": "441" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single key-value store.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 51, + "module": "client", + "name": "key_value_store", + "parsedDocstring": { + "text": "Retrieve the sub-client for manipulating a single 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/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 122 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single key-value store.\n" + } + ] + }, + "flags": {}, + "id": 52, + "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": 53, + "kind": 32768, + "kindString": "Parameter", + "name": "key_value_store_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "KeyValueStoreClient", + "type": "reference", + "target": "412" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating key-value stores." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 54, + "module": "client", + "name": "key_value_stores", + "parsedDocstring": { + "text": "Retrieve the sub-client for manipulating key-value stores." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 130 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating key-value stores." + } + ] + }, + "flags": {}, + "id": 55, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "key_value_stores", + "parameters": [], + "type": { + "name": "KeyValueStoreCollectionClient", + "type": "reference", + "target": "398" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single request queue.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 56, + "module": "client", + "name": "request_queue", + "parsedDocstring": { + "text": "Retrieve the sub-client for manipulating a single 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/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 134 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single request queue.\n" + } + ] + }, + "flags": {}, + "id": 57, + "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": 58, + "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": 59, + "kind": 32768, + "kindString": "Parameter", + "name": "client_key", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "RequestQueueClient", + "type": "reference", + "target": "359" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating request queues." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 60, + "module": "client", + "name": "request_queues", + "parsedDocstring": { + "text": "Retrieve the sub-client for manipulating request queues." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 143 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating request queues." + } + ] + }, + "flags": {}, + "id": 61, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "request_queues", + "parameters": [], + "type": { + "name": "RequestQueueCollectionClient", + "type": "reference", + "target": "345" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single webhook.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 62, + "module": "client", + "name": "webhook", + "parsedDocstring": { + "text": "Retrieve the sub-client for manipulating a single webhook.\n", + "args": { + "webhook_id": "ID of the webhook to be manipulated" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 147 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single webhook.\n" + } + ] + }, + "flags": {}, + "id": 63, + "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": 64, + "kind": 32768, + "kindString": "Parameter", + "name": "webhook_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "WebhookClient", + "type": "reference", + "target": "173" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple webhooks of a user." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 65, + "module": "client", + "name": "webhooks", + "parsedDocstring": { + "text": "Retrieve the sub-client for querying multiple webhooks of a user." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 155 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple webhooks of a user." + } + ] + }, + "flags": {}, + "id": 66, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "webhooks", + "parameters": [], + "type": { + "name": "WebhookCollectionClient", + "type": "reference", + "target": "151" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for accessing a single webhook dispatch.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 67, + "module": "client", + "name": "webhook_dispatch", + "parsedDocstring": { + "text": "Retrieve the sub-client for accessing a single webhook dispatch.\n", + "args": { + "webhook_dispatch_id": "ID of the webhook dispatch to access" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 159 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for accessing a single webhook dispatch.\n" + } + ] + }, + "flags": {}, + "id": 68, + "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": 69, + "kind": 32768, + "kindString": "Parameter", + "name": "webhook_dispatch_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "WebhookDispatchClient", + "type": "reference", + "target": "144" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple webhook dispatches of a user." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 70, + "module": "client", + "name": "webhook_dispatches", + "parsedDocstring": { + "text": "Retrieve the sub-client for querying multiple webhook dispatches of a user." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 167 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying multiple webhook dispatches of a user." + } + ] + }, + "flags": {}, + "id": 71, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "webhook_dispatches", + "parameters": [], + "type": { + "name": "WebhookDispatchCollectionClient", + "type": "reference", + "target": "134" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single schedule.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 72, + "module": "client", + "name": "schedule", + "parsedDocstring": { + "text": "Retrieve the sub-client for manipulating a single schedule.\n", + "args": { + "schedule_id": "ID of the schedule to be manipulated" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 171 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single schedule.\n" + } + ] + }, + "flags": {}, + "id": 73, + "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": 74, + "kind": 32768, + "kindString": "Parameter", + "name": "schedule_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "ScheduleClient", + "type": "reference", + "target": "285" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating schedules." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 75, + "module": "client", + "name": "schedules", + "parsedDocstring": { + "text": "Retrieve the sub-client for manipulating schedules." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 179 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating schedules." + } + ] + }, + "flags": {}, + "id": 76, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "schedules", + "parameters": [], + "type": { + "name": "ScheduleCollectionClient", + "type": "reference", + "target": "266" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for retrieving logs.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 77, + "module": "client", + "name": "log", + "parsedDocstring": { + "text": "Retrieve the sub-client for retrieving logs.\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/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 183 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for retrieving logs.\n" + } + ] + }, + "flags": {}, + "id": 78, + "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": 79, + "kind": 32768, + "kindString": "Parameter", + "name": "build_or_run_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "LogClient", + "type": "reference", + "target": "389" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single task.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 80, + "module": "client", + "name": "task", + "parsedDocstring": { + "text": "Retrieve the sub-client for manipulating a single task.\n", + "args": { + "task_id": "ID of the task to be manipulated" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 191 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating a single task.\n" + } + ] + }, + "flags": {}, + "id": 81, + "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": 82, + "kind": 32768, + "kindString": "Parameter", + "name": "task_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "TaskClient", + "type": "reference", + "target": "222" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating tasks." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 83, + "module": "client", + "name": "tasks", + "parsedDocstring": { + "text": "Retrieve the sub-client for manipulating tasks." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 199 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for manipulating tasks." + } + ] + }, + "flags": {}, + "id": 84, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "tasks", + "parameters": [], + "type": { + "name": "TaskCollectionClient", + "type": "reference", + "target": "204" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying users.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 85, + "module": "client", + "name": "user", + "parsedDocstring": { + "text": "Retrieve the sub-client for querying users.\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/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 203 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the sub-client for querying users.\n" + } + ] + }, + "flags": {}, + "id": 86, + "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": 87, + "kind": 32768, + "kindString": "Parameter", + "name": "user_id", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "UserClient", + "type": "reference", + "target": "197" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Apify API client." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 25, + 31, + 34, + 36, + 39, + 46, + 49, + 51, + 54, + 77, + 56, + 60, + 41, + 44, + 72, + 75, + 80, + 83, + 85, + 62, + 67, + 70, + 65 + ], + "title": "Methods" + } + ], + "id": 24, + "module": "client", + "name": "ApifyClient", + "parsedDocstring": { + "text": "The Apify API client." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 33 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 88, + "module": "_version", + "name": "__version__", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_version.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 1 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 89, + "module": "_utils", + "name": "PARSE_DATE_FIELDS_MAX_DEPTH", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 14 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 90, + "module": "_utils", + "name": "PARSE_DATE_FIELDS_KEY_SUFFIX", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 15 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 91, + "module": "_utils", + "name": "NOT_FOUND_TYPE", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 17 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 92, + "module": "_utils", + "name": "NOT_FOUND_ON_S3", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 18 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 93, + "module": "_utils", + "name": "T", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 89 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 94, + "module": "_utils", + "name": "BailType", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 90 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "list: List of returned objects on this page" + } + ] + }, + "flags": {}, + "groups": [], + "id": 96, + "module": "_utils", + "name": "items", + "parsedDocstring": { + "text": "list: List of returned objects on this page" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 217 + } + ], + "type": { + "name": "List", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "int: Count of the returned objects on this page" + } + ] + }, + "flags": {}, + "groups": [], + "id": 97, + "module": "_utils", + "name": "count", + "parsedDocstring": { + "text": "int: Count of the returned objects on this page" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 219 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "int: The limit on the number of returned objects offset specified in the API call" + } + ] + }, + "flags": {}, + "groups": [], + "id": 98, + "module": "_utils", + "name": "offset", + "parsedDocstring": { + "text": "int: The limit on the number of returned objects offset specified in the API call" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 221 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "int: The offset of the first object specified in the API call" + } + ] + }, + "flags": {}, + "groups": [], + "id": 99, + "module": "_utils", + "name": "limit", + "parsedDocstring": { + "text": "int: The offset of the first object specified in the API call" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 223 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "int: Total number of objects matching the API call criteria" + } + ] + }, + "flags": {}, + "groups": [], + "id": 100, + "module": "_utils", + "name": "total", + "parsedDocstring": { + "text": "int: Total number of objects matching the API call criteria" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 225 + } + ], + "type": { + "name": "int", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "bool: Whether the listing is descending or not" + } + ] + }, + "flags": {}, + "groups": [], + "id": 101, + "module": "_utils", + "name": "desc", + "parsedDocstring": { + "text": "bool: Whether the listing is descending or not" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 227 + } + ], + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a ListPage instance from the API response data." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 102, + "module": "_utils", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize a ListPage instance from the API response data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 229 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize a ListPage instance from the API response data." + } + ] + }, + "flags": {}, + "id": 103, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 104, + "kind": 32768, + "kindString": "Parameter", + "name": "data", + "type": { + "name": "Dict", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "A single page of items returned from a list() method." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 102 + ], + "title": "Methods" + }, + { + "children": [ + 97, + 101, + 96, + 99, + 98, + 100 + ], + "title": "Properties" + } + ], + "id": 95, + "module": "_utils", + "name": "ListPage", + "parsedDocstring": { + "text": "A single page of items returned from a list() method." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_utils.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 213 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 105, + "module": "_types", + "name": "JSONSerializable", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_types.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 6 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 106, + "module": "_http_client", + "name": "DEFAULT_BACKOFF_EXPONENTIAL_FACTOR", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_http_client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 15 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 107, + "module": "_http_client", + "name": "DEFAULT_BACKOFF_RANDOM_FACTOR", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_http_client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 16 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 109, + "module": "_http_client", + "name": "__init__", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_http_client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 20 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 110, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 111, + "kind": 32768, + "kindString": "Parameter", + "name": "token", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "defaultValue": "8", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 112, + "kind": 32768, + "kindString": "Parameter", + "name": "max_retries", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "defaultValue": "500", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 113, + "kind": 32768, + "kindString": "Parameter", + "name": "min_delay_between_retries_millis", + "type": { + "name": "int", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 114, + "module": "_http_client", + "name": "call", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_http_client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 35 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "flags": {}, + "id": 115, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "call", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 116, + "kind": 32768, + "kindString": "Parameter", + "name": "method", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 117, + "kind": 32768, + "kindString": "Parameter", + "name": "url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 118, + "kind": 32768, + "kindString": "Parameter", + "name": "headers", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 119, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 120, + "kind": 32768, + "kindString": "Parameter", + "name": "data", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Any" + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 121, + "kind": 32768, + "kindString": "Parameter", + "name": "json", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "JSONSerializable", + "target": "105" + } + ] + } + }, + { + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 122, + "kind": 32768, + "kindString": "Parameter", + "name": "stream", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "defaultValue": "True", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 123, + "kind": 32768, + "kindString": "Parameter", + "name": "parse_response", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + } + ], + "type": { + "name": "requests.models.Response", + "type": "reference" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 109, + 114 + ], + "title": "Methods" + } + ], + "id": 108, + "module": "_http_client", + "name": "_HTTPClient", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_http_client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 19 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for errors specific to the Apify API Client." + } + ] + }, + "flags": {}, + "groups": [], + "id": 124, + "module": "_errors", + "name": "ApifyClientError", + "parsedDocstring": { + "text": "Base class for errors specific to the Apify API Client." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_errors.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 7 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "ApifyApiError", + "target": "125", + "type": "reference" + }, + { + "name": "InvalidResponseBodyError", + "target": "130", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create the ApifyApiError instance.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 126, + "module": "_errors", + "name": "__init__", + "parsedDocstring": { + "text": "Create the ApifyApiError instance.\n", + "args": { + "response": "The response to the failed API call", + "attempt": "Which attempt was the request that failed" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_errors.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 22 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create the ApifyApiError instance.\n" + } + ] + }, + "flags": {}, + "id": 127, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The response to the failed API call" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 128, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "requests.models.Response", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Which attempt was the request that failed" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 129, + "kind": 32768, + "kindString": "Parameter", + "name": "attempt", + "type": { + "name": "int", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "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,\nbut the API responds with an error response. Typically, those are rate limit\nerrors and internal errors, which are automatically retried, or validation\nerrors, which are thrown immediately, because a correction by the user is needed." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 126 + ], + "title": "Methods" + } + ], + "id": 125, + "module": "_errors", + "name": "ApifyApiError", + "parsedDocstring": { + "text": "Error specific to requests to the Apify API.\n\nAn `ApifyApiError` is thrown for successful HTTP requests that reach the API,\nbut the API responds with an error response. Typically, those are rate limit\nerrors and internal errors, which are automatically retried, or validation\nerrors, which are thrown immediately, because a correction by the user is needed." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_errors.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 13 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ApifyClientError", + "target": "124", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create the InvalidResponseBodyError instance.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 131, + "module": "_errors", + "name": "__init__", + "parsedDocstring": { + "text": "Create the InvalidResponseBodyError instance.\n", + "args": { + "response": "The response which failed to be parsed" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_errors.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 62 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Create the InvalidResponseBodyError instance.\n" + } + ] + }, + "flags": {}, + "id": 132, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The response which failed to be parsed" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 133, + "kind": 32768, + "kindString": "Parameter", + "name": "response", + "type": { + "name": "requests.models.Response", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "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\nan attempt to parse the JSON throws an error. In most cases this can be resolved by retrying the\nrequest. We do that by identifying this error in the _HTTPClient." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 131 + ], + "title": "Methods" + } + ], + "id": 130, + "module": "_errors", + "name": "InvalidResponseBodyError", + "parsedDocstring": { + "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\nan attempt to parse the JSON throws an error. In most cases this can be resolved by retrying the\nrequest. We do that by identifying this error in the _HTTPClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/_errors.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 54 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ApifyClientError", + "target": "124", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the WebhookDispatchCollectionClient." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 135, + "module": "clients.resource_clients.webhook_dispatch_collection", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the WebhookDispatchCollectionClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 10 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the WebhookDispatchCollectionClient." + } + ] + }, + "flags": {}, + "id": 136, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 137, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 138, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "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": 139, + "module": "clients.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\n" + }, + "returns": "ListPage: The retrieved webhook dispatches of a user" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 15 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "ListPage: 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": 140, + "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": 141, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "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": 142, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the webhook dispatches in descending order based on the date of their creation\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 143, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + } + ], + "type": { + "name": "ListPage", + "type": "reference", + "target": "95" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for listing webhook dispatches." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 135, + 139 + ], + "title": "Methods" + } + ], + "id": 134, + "module": "clients.resource_clients.webhook_dispatch_collection", + "name": "WebhookDispatchCollectionClient", + "parsedDocstring": { + "text": "Sub-client for listing webhook dispatches." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 7 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceCollectionClient", + "target": "680", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the WebhookDispatchClient." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 145, + "module": "clients.resource_clients.webhook_dispatch", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the WebhookDispatchClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/webhook_dispatch.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 9 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the WebhookDispatchClient." + } + ] + }, + "flags": {}, + "id": 146, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 147, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 148, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "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": 149, + "module": "clients.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", + "returns": "dict, optional: The retrieved webhook dispatch, or None if it does not exist" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/webhook_dispatch.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 14 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict, optional: 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": 150, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for querying information about a webhook dispatch." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 145, + 149 + ], + "title": "Methods" + } + ], + "id": 144, + "module": "clients.resource_clients.webhook_dispatch", + "name": "WebhookDispatchClient", + "parsedDocstring": { + "text": "Sub-client for querying information about a webhook dispatch." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/webhook_dispatch.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 6 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "681", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the WebhookCollectionClient." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 152, + "module": "clients.resource_clients.webhook_collection", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the WebhookCollectionClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/webhook_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 13 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the WebhookCollectionClient." + } + ] + }, + "flags": {}, + "id": 153, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 154, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 155, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "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": 156, + "module": "clients.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\n" + }, + "returns": "ListPage: The list of available webhooks matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/webhook_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 18 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "ListPage: 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": 157, + "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": 158, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What webhook to include as first when retrieving the list" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 159, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the webhooks in descending order based on their date of creation\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 160, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + } + ], + "type": { + "name": "ListPage", + "type": "reference", + "target": "95" + } + } + ] + }, + { + "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": 161, + "module": "clients.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", + "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\nfailure.", + "idempotency_key": "A unique identifier of a webhook. You can use it to ensure that you won't\ncreate the same webhook multiple times.", + "is_ad_hoc": "Set to True if you want the webhook to be triggered only the first time the\ncondition is fulfilled. Only applicable when actor_run_id is filled.\n" + }, + "returns": "dict: The created webhook" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/webhook_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 39 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 162, + "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": 163, + "kind": 32768, + "kindString": "Parameter", + "name": "event_types", + "type": { + "name": "List", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookEventType", + "target": "15" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "URL that will be invoked once the webhook is triggered." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 164, + "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": 165, + "kind": 32768, + "kindString": "Parameter", + "name": "payload_template", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Id of the actor whose runs should trigger the webhook." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 166, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_id", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "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": 167, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_task_id", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Id of the actor run which should trigger the webhook." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 168, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_run_id", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "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": 169, + "kind": 32768, + "kindString": "Parameter", + "name": "ignore_ssl_errors", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the webhook should retry sending the payload to request_url upon\nfailure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 170, + "kind": 32768, + "kindString": "Parameter", + "name": "do_not_retry", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique identifier of a webhook. You can use it to ensure that you won't\ncreate the same webhook multiple times." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 171, + "kind": 32768, + "kindString": "Parameter", + "name": "idempotency_key", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set to True if you want the webhook to be triggered only the first time the\ncondition is fulfilled. Only applicable when actor_run_id is filled.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 172, + "kind": 32768, + "kindString": "Parameter", + "name": "is_ad_hoc", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating webhooks." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 152, + 161, + 156 + ], + "title": "Methods" + } + ], + "id": 151, + "module": "clients.resource_clients.webhook_collection", + "name": "WebhookCollectionClient", + "parsedDocstring": { + "text": "Sub-client for manipulating webhooks." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/webhook_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 10 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceCollectionClient", + "target": "680", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the WebhookClient." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 174, + "module": "clients.resource_clients.webhook", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the WebhookClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/webhook.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 51 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the WebhookClient." + } + ] + }, + "flags": {}, + "id": 175, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 176, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 177, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "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": 178, + "module": "clients.resource_clients.webhook", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook\n", + "returns": "dict, optional: The retrieved webhook, or None if it does not exist" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/webhook.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 56 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict, optional: 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": 179, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + }, + { + "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": 180, + "module": "clients.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", + "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\nfailure.", + "is_ad_hoc": "Set to True if you want the webhook to be triggered only the first time the\ncondition is fulfilled. Only applicable when actor_run_id is filled.\n" + }, + "returns": "dict: The updated webhook" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/webhook.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 66 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 181, + "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": 182, + "kind": 32768, + "kindString": "Parameter", + "name": "event_types", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "WebhookEventType", + "target": "15" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "URL that will be invoked once the webhook is triggered." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 183, + "kind": 32768, + "kindString": "Parameter", + "name": "request_url", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "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": 184, + "kind": 32768, + "kindString": "Parameter", + "name": "payload_template", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Id of the actor whose runs should trigger the webhook." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 185, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_id", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "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": 186, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_task_id", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Id of the actor run which should trigger the webhook." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 187, + "kind": 32768, + "kindString": "Parameter", + "name": "actor_run_id", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "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": 188, + "kind": 32768, + "kindString": "Parameter", + "name": "ignore_ssl_errors", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the webhook should retry sending the payload to request_url upon\nfailure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 189, + "kind": 32768, + "kindString": "Parameter", + "name": "do_not_retry", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Set to True if you want the webhook to be triggered only the first time the\ncondition is fulfilled. Only applicable when actor_run_id is filled.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 190, + "kind": 32768, + "kindString": "Parameter", + "name": "is_ad_hoc", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + }, + { + "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" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 191, + "module": "clients.resource_clients.webhook", + "name": "delete", + "parsedDocstring": { + "text": "Delete the webhook.\n\nhttps://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/webhook.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 104 + } + ], + "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" + } + ] + }, + "flags": {}, + "id": 192, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [], + "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": 193, + "module": "clients.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", + "returns": "dict, optional: The webhook dispatch created by the test" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/webhook.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 111 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict, optional: 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": 194, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "test", + "parameters": [], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + }, + { + "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": 195, + "module": "clients.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": "WebhookDispatchCollectionClient: A client allowing access to dispatches of this webhook using its list method" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/webhook.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 135 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "WebhookDispatchCollectionClient: 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": 196, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "dispatches", + "parameters": [], + "type": { + "name": "WebhookDispatchCollectionClient", + "type": "reference", + "target": "134" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single webhook." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 174, + 191, + 195, + 178, + 193, + 180 + ], + "title": "Methods" + } + ], + "id": 173, + "module": "clients.resource_clients.webhook", + "name": "WebhookClient", + "parsedDocstring": { + "text": "Sub-client for manipulating a single webhook." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/webhook.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 48 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "681", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the UserClient." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 198, + "module": "clients.resource_clients.user", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the UserClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/user.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 9 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the UserClient." + } + ] + }, + "flags": {}, + "id": 199, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 200, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 201, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "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": 202, + "module": "clients.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", + "returns": "dict, optional: The retrieved user data, or None if the user does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/user.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 15 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict, optional: 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": 203, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for querying user data." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 198, + 202 + ], + "title": "Methods" + } + ], + "id": 197, + "module": "clients.resource_clients.user", + "name": "UserClient", + "parsedDocstring": { + "text": "Sub-client for querying user data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/user.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 6 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "681", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the TaskCollectionClient." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 205, + "module": "clients.resource_clients.task_collection", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the TaskCollectionClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/task_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 10 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the TaskCollectionClient." + } + ] + }, + "flags": {}, + "id": 206, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 207, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 208, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "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": 209, + "module": "clients.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\n" + }, + "returns": "ListPage: The list of available tasks matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/task_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 15 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "ListPage: 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": 210, + "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": 211, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What task to include as first when retrieving the list" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 212, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the tasks in descending order based on their creation date\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 213, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + } + ], + "type": { + "name": "ListPage", + "type": "reference", + "target": "95" + } + } + ] + }, + { + "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": 214, + "module": "clients.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.\nBy default, the run uses the build specified in the task settings (typically latest).", + "memory_mbytes": "Memory limit for the run, in megabytes.\nBy default, the run uses a memory limit specified in the task settings.", + "timeout_secs": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in the task settings.", + "task_input": "Task input object.\n" + }, + "returns": "dict: The created task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/task_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 36 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 215, + "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": 216, + "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": 217, + "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.\nBy default, the run uses the build specified in the task settings (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 218, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 219, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_secs", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes.\nBy default, the run uses a memory limit specified in the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 220, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Task input object.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 221, + "kind": 32768, + "kindString": "Parameter", + "name": "task_input", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating tasks." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 205, + 214, + 209 + ], + "title": "Methods" + } + ], + "id": 204, + "module": "clients.resource_clients.task_collection", + "name": "TaskCollectionClient", + "parsedDocstring": { + "text": "Sub-client for manipulating tasks." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/task_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 7 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceCollectionClient", + "target": "680", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the TaskClient." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 223, + "module": "clients.resource_clients.task", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the TaskClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/task.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 22 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the TaskClient." + } + ] + }, + "flags": {}, + "id": 224, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 225, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 226, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "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": 227, + "module": "clients.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", + "returns": "dict, optional: The retrieved task" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/task.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 27 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict, optional: 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": 228, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + }, + { + "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": 229, + "module": "clients.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.\nBy default, the run uses the build specified in the task settings (typically latest).", + "memory_mbytes": "Memory limit for the run, in megabytes.\nBy default, the run uses a memory limit specified in the task settings.", + "timeout_secs": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in the task settings.", + "task_input": "Task input dictionary\n" + }, + "returns": "dict: The updated task" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/task.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 37 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 230, + "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": 231, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Task input dictionary\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 232, + "kind": 32768, + "kindString": "Parameter", + "name": "task_input", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actor build to run. It can be either a build tag or build number.\nBy default, the run uses the build specified in the task settings (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 233, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes.\nBy default, the run uses a memory limit specified in the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 234, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 235, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_secs", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + }, + { + "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" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 236, + "module": "clients.resource_clients.task", + "name": "delete", + "parsedDocstring": { + "text": "Delete the task.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/task-object/delete-task" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/task.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 74 + } + ], + "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" + } + ] + }, + "flags": {}, + "id": 237, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [], + "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": 238, + "module": "clients.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.\nBy default, the run uses the build specified in the task settings (typically latest).", + "memory_mbytes": "Memory limit for the run, in megabytes.\nBy default, the run uses a memory limit specified in the task settings.", + "timeout_secs": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in the task settings.", + "wait_for_finish": "The maximum number of seconds the server waits for the run to finish.\nBy default, it is 0, the maximum value is 300.", + "webhooks": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks)\nassociated with the actor run which can be used to receive a notification,\ne.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): Optional template for the request payload\n" + }, + "returns": "dict: The run object" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/task.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 81 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 239, + "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": 240, + "kind": 32768, + "kindString": "Parameter", + "name": "task_input", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the actor build to run. It can be either a build tag or build number.\nBy default, the run uses the build specified in the task settings (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 241, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes.\nBy default, the run uses a memory limit specified in the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 242, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 243, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_secs", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of seconds the server waits for the run to finish.\nBy default, it is 0, the maximum value is 300." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 244, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_for_finish", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks)\nassociated with the actor run which can be used to receive a notification,\ne.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): Optional template for the request payload\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 245, + "kind": 32768, + "kindString": "Parameter", + "name": "webhooks", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + }, + { + "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_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 246, + "module": "clients.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_secs 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.\nBy default, the run uses the build specified in the task settings (typically latest).", + "memory_mbytes": "Memory limit for the run, in megabytes.\nBy default, the run uses a memory limit specified in the task settings.", + "timeout_secs": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in the task settings.", + "webhooks": "Specifies optional webhooks associated with the actor run, which can be used to receive a notification\ne.g. when the actor finished or failed. Note: if you already have a webhook set up for the actor or task,\nyou do not have to add it again here.", + "wait_secs": "The maximum number of seconds the server waits for the task run to finish. If not provided, waits indefinitely.\n" + }, + "returns": "dict: The run object" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/task.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 134 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actor-tasks/run-collection/run-task\n" + } + ] + }, + "flags": {}, + "id": 247, + "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": 248, + "kind": 32768, + "kindString": "Parameter", + "name": "task_input", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict", + "typeArguments": [ + { + "type": "reference", + "name": "str" + }, + { + "type": "reference", + "name": "Any" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the actor build to run. It can be either a build tag or build number.\nBy default, the run uses the build specified in the task settings (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 249, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes.\nBy default, the run uses a memory limit specified in the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 250, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run, in seconds. By default, the run uses timeout specified in the task settings." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 251, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_secs", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies optional webhooks associated with the actor run, which can be used to receive a notification\ne.g. when the actor finished or failed. Note: if you already have a webhook set up for the actor or task,\nyou do not have to add it again here." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 252, + "kind": 32768, + "kindString": "Parameter", + "name": "webhooks", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of seconds the server waits for the task run to finish. If not provided, waits indefinitely.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 253, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_secs", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + } + ], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + }, + { + "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": 254, + "module": "clients.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", + "returns": "dict, optional: Retrieved task input" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/task.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 175 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict, optional: 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": 255, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_input", + "parameters": [], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + }, + { + "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": 256, + "module": "clients.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", + "returns": "dict, Retrieved task input" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/task.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 194 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict, Retrieved 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": 257, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "update_input", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 258, + "kind": 32768, + "kindString": "Parameter", + "name": "task_input", + "type": { + "name": "Dict", + "type": "reference" + } + } + ], + "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": 259, + "module": "clients.resource_clients.task", + "name": "runs", + "parsedDocstring": { + "text": "Retrieve a client for the runs of this task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/task.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 210 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this task." + } + ] + }, + "flags": {}, + "id": 260, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "runs", + "parameters": [], + "type": { + "name": "RunCollectionClient", + "type": "reference", + "target": "305" + } + } + ] + }, + { + "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": 261, + "module": "clients.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.\n" + }, + "returns": "RunClient: The resource client for the last run of this task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/task.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 214 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "RunClient: 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": 262, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "last_run", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Consider only runs with this status.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 263, + "kind": 32768, + "kindString": "Parameter", + "name": "status", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorJobStatus", + "target": "1" + } + ] + } + } + ], + "type": { + "name": "RunClient", + "type": "reference", + "target": "316" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this task." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 264, + "module": "clients.resource_clients.task", + "name": "webhooks", + "parsedDocstring": { + "text": "Retrieve a client for webhooks associated with this task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/task.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 231 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this task." + } + ] + }, + "flags": {}, + "id": 265, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "webhooks", + "parameters": [], + "type": { + "name": "WebhookCollectionClient", + "type": "reference", + "target": "151" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single task." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 223, + 246, + 236, + 227, + 254, + 261, + 259, + 238, + 229, + 256, + 264 + ], + "title": "Methods" + } + ], + "id": 222, + "module": "clients.resource_clients.task", + "name": "TaskClient", + "parsedDocstring": { + "text": "Sub-client for manipulating a single task." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/task.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 19 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "681", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the ScheduleCollectionClient with the passed arguments." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 267, + "module": "clients.resource_clients.schedule_collection", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the ScheduleCollectionClient with the passed arguments." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/schedule_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 10 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the ScheduleCollectionClient with the passed arguments." + } + ] + }, + "flags": {}, + "id": 268, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 269, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 270, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "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": 271, + "module": "clients.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\n" + }, + "returns": "ListPage: The list of available schedules matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/schedule_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 15 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "ListPage: 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": 272, + "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": 273, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What schedules to include as first when retrieving the list" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 274, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the schedules in descending order based on their modification date\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 275, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + } + ], + "type": { + "name": "ListPage", + "type": "reference", + "target": "95" + } + } + ] + }, + { + "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": 276, + "module": "clients.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 schedule.", + "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 https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)\n" + }, + "returns": "dict: The created schedule." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/schedule_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 36 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 277, + "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": 278, + "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": 279, + "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 schedule." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 280, + "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": 281, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Actors or tasks that should be run on this schedule. See the API documentation for exact structure." + } + ] + }, + "defaultValue": "[]", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 282, + "kind": 32768, + "kindString": "Parameter", + "name": "actions", + "type": { + "name": "List", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Description of this schedule" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 283, + "kind": 32768, + "kindString": "Parameter", + "name": "description", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timezone in which your cron expression runs (TZ database name from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 284, + "kind": 32768, + "kindString": "Parameter", + "name": "timezone", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating schedules." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 267, + 276, + 271 + ], + "title": "Methods" + } + ], + "id": 266, + "module": "clients.resource_clients.schedule_collection", + "name": "ScheduleCollectionClient", + "parsedDocstring": { + "text": "Sub-client for manipulating schedules." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/schedule_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 7 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceCollectionClient", + "target": "680", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the ScheduleClient." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 286, + "module": "clients.resource_clients.schedule", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the ScheduleClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/schedule.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 11 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the ScheduleClient." + } + ] + }, + "flags": {}, + "id": 287, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 288, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 289, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "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": 290, + "module": "clients.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", + "returns": "dict, optional: The retrieved schedule" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/schedule.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 16 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict, optional: 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": 291, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + }, + { + "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": 292, + "module": "clients.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 schedule.", + "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\n(TZ database name from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)\n" + }, + "returns": "dict: The updated schedule" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/schedule.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 26 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 293, + "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": 294, + "kind": 32768, + "kindString": "Parameter", + "name": "cron_expression", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "True if the schedule should be enabled" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 295, + "kind": 32768, + "kindString": "Parameter", + "name": "is_enabled", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "When set to true, don't start actor or actor task if it's still running from the previous schedule." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 296, + "kind": 32768, + "kindString": "Parameter", + "name": "is_exclusive", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the schedule to create." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 297, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "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": 298, + "kind": 32768, + "kindString": "Parameter", + "name": "actions", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Description of this schedule" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 299, + "kind": 32768, + "kindString": "Parameter", + "name": "description", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Timezone in which your cron expression runs\n(TZ database name from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 300, + "kind": 32768, + "kindString": "Parameter", + "name": "timezone", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + }, + { + "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" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 301, + "module": "clients.resource_clients.schedule", + "name": "delete", + "parsedDocstring": { + "text": "Delete the schedule.\n\nhttps://docs.apify.com/api/v2#/reference/schedules/schedule-object/delete-schedule" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/schedule.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 60 + } + ], + "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" + } + ] + }, + "flags": {}, + "id": 302, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [], + "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": 303, + "module": "clients.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", + "returns": "list, optional: Retrieved log of the given schedule" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/schedule.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 67 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "list, optional: 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": 304, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_log", + "parameters": [], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List" + } + ] + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single schedule." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 286, + 301, + 290, + 303, + 292 + ], + "title": "Methods" + } + ], + "id": 285, + "module": "clients.resource_clients.schedule", + "name": "ScheduleClient", + "parsedDocstring": { + "text": "Sub-client for manipulating a single schedule." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/schedule.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 8 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "681", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the RunCollectionClient." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 306, + "module": "clients.resource_clients.run_collection", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the RunCollectionClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/run_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 11 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the RunCollectionClient." + } + ] + }, + "flags": {}, + "id": 307, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 308, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 309, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all actor runs (either of a single actor, or all user's actors, depending on where this client was 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": 310, + "module": "clients.resource_clients.run_collection", + "name": "list", + "parsedDocstring": { + "text": "List all actor runs (either of a single actor, or all user's actors, depending on where this client was 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 status\n" + }, + "returns": "ListPage: The retrieved actor runs" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/run_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 16 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "ListPage: The retrieved actor runs" + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List all actor runs (either of a single actor, or all user's actors, depending on where this client was 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": 311, + "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": 312, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What run to include as first when retrieving the list" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 313, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "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": 314, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve only runs with the provided status\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 315, + "kind": 32768, + "kindString": "Parameter", + "name": "status", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorJobStatus", + "target": "1" + } + ] + } + } + ], + "type": { + "name": "ListPage", + "type": "reference", + "target": "95" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for listing actor runs." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 306, + 310 + ], + "title": "Methods" + } + ], + "id": 305, + "module": "clients.resource_clients.run_collection", + "name": "RunCollectionClient", + "parsedDocstring": { + "text": "Sub-client for listing actor runs." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/run_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 8 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceCollectionClient", + "target": "680", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the RunClient." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 317, + "module": "clients.resource_clients.run", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the RunClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/run.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 14 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the RunClient." + } + ] + }, + "flags": {}, + "id": 318, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 319, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 320, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ActorJobBaseClient.__init__", + "target": 696, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ActorJobBaseClient.__init__", + "target": 696, + "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": 321, + "module": "clients.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", + "returns": "dict: The retrieved actor run data" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/run.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 19 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 322, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + }, + { + "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": 323, + "module": "clients.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.\nIt will send ``aborting`` and ``persistStates`` events into the run and force-stop the run after 30 seconds.\nIt is helpful in cases where you plan to resurrect the run later.\n" + }, + "returns": "dict: The data of the aborted actor run" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/run.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 29 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 324, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "abort", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, the actor run will abort gracefully.\nIt will send ``aborting`` and ``persistStates`` events into the run and force-stop the run after 30 seconds.\nIt is helpful in cases where you plan to resurrect the run later.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 325, + "kind": 32768, + "kindString": "Parameter", + "name": "gracefully", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + }, + { + "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": 326, + "module": "clients.resource_clients.run", + "name": "wait_for_finish", + "parsedDocstring": { + "text": "Wait synchronously until the run finishes or the server times out.\n", + "args": { + "wait_secs": "how long does the client wait for run to finish. None for indefinite.\n" + }, + "returns": "dict, optional: The actor run data. If the status on the object is not one of the terminal statuses\n(SUCEEDED, FAILED, TIMED_OUT, ABORTED), then the run has not yet finished." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/run.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 44 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict, optional: The actor run data. If the status on the object is not one of the terminal statuses\n(SUCEEDED, FAILED, TIMED_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": 327, + "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.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 328, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_secs", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + } + ], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + }, + { + "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": 329, + "module": "clients.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 (typically the latest build).", + "run_input": "The input to pass to the new run.", + "content_type": "The content type of the input.\n" + }, + "returns": "dict: The actor run data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/run.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 56 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 330, + "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": 331, + "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 (typically the latest build)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 332, + "kind": 32768, + "kindString": "Parameter", + "name": "target_actor_build", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The input to pass to the new run." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 333, + "kind": 32768, + "kindString": "Parameter", + "name": "run_input", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Any" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the input.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 334, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + }, + { + "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": 335, + "module": "clients.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", + "returns": "dict: The actor run data." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/run.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 97 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 336, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "resurrect", + "parameters": [], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + }, + { + "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": 337, + "module": "clients.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": "DatasetClient: A client allowing access to the default dataset of this actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/run.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 116 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "DatasetClient: 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": 338, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "dataset", + "parameters": [], + "type": { + "name": "DatasetClient", + "type": "reference", + "target": "455" + } + } + ] + }, + { + "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": 339, + "module": "clients.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": "KeyValueStoreClient: A client allowing access to the default key-value store of this actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/run.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 128 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "KeyValueStoreClient: 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": 340, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "key_value_store", + "parameters": [], + "type": { + "name": "KeyValueStoreClient", + "type": "reference", + "target": "412" + } + } + ] + }, + { + "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": 341, + "module": "clients.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": "RequestQueueClient: A client allowing access to the default request_queue of this actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/run.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 140 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "RequestQueueClient: 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": 342, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "request_queue", + "parameters": [], + "type": { + "name": "RequestQueueClient", + "type": "reference", + "target": "359" + } + } + ] + }, + { + "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": 343, + "module": "clients.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": "LogClient: A client allowing access to the log of this actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/run.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 152 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "LogClient: 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": 344, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "log", + "parameters": [], + "type": { + "name": "LogClient", + "type": "reference", + "target": "389" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single actor run." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 317, + 323, + 337, + 321, + 339, + 343, + 329, + 341, + 335, + 326 + ], + "title": "Methods" + } + ], + "id": 316, + "module": "clients.resource_clients.run", + "name": "RunClient", + "parsedDocstring": { + "text": "Sub-client for manipulating a single actor run." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/run.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 11 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ActorJobBaseClient", + "target": "693", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the RequestQueueCollectionClient with the passed arguments." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 346, + "module": "clients.resource_clients.request_queue_collection", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the RequestQueueCollectionClient with the passed arguments." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/request_queue_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 10 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the RequestQueueCollectionClient with the passed arguments." + } + ] + }, + "flags": {}, + "id": 347, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 348, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 349, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "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": 350, + "module": "clients.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 therequest queues in descending order based on their modification date\n" + }, + "returns": "ListPage: The list of available request queues matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/request_queue_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 15 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "ListPage: 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": 351, + "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": 352, + "kind": 32768, + "kindString": "Parameter", + "name": "unnamed", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many request queues to retrieve" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 353, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "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": 354, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort therequest queues in descending order based on their modification date\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 355, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + } + ], + "type": { + "name": "ListPage", + "type": "reference", + "target": "95" + } + } + ] + }, + { + "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": 356, + "module": "clients.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.\n" + }, + "returns": "dict: The retrieved or newly-created request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/request_queue_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 38 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 357, + "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.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 358, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating request queues." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 346, + 356, + 350 + ], + "title": "Methods" + } + ], + "id": 345, + "module": "clients.resource_clients.request_queue_collection", + "name": "RequestQueueCollectionClient", + "parsedDocstring": { + "text": "Sub-client for manipulating request queues." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/request_queue_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 7 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceCollectionClient", + "target": "680", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the RequestQueueClient.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 360, + "module": "clients.resource_clients.request_queue", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the RequestQueueClient.\n", + "args": { + "client_key": "A unique identifier of the client accessing the request queue" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/request_queue.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 11 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the RequestQueueClient.\n" + } + ] + }, + "flags": {}, + "id": 361, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 362, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "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": 363, + "kind": 32768, + "kindString": "Parameter", + "name": "client_key", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 364, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "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": 365, + "module": "clients.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", + "returns": "dict, optional: The retrieved request queue, or None, if it does not exist" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/request_queue.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 21 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict, optional: 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": 366, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + }, + { + "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": 367, + "module": "clients.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\n" + }, + "returns": "dict: The updated request queue" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/request_queue.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 31 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 368, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new name for the request queue\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 369, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + }, + { + "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" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 370, + "module": "clients.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" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/request_queue.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 48 + } + ], + "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" + } + ] + }, + "flags": {}, + "id": 371, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [], + "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": 372, + "module": "clients.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\n" + }, + "returns": "dict: The desired number of requests from the beginning of the queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/request_queue.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 55 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 373, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list_head", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many requests to retrieve\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 374, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + }, + { + "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": 375, + "module": "clients.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\n" + }, + "returns": "dict: The added request." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/request_queue.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 76 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 376, + "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": 377, + "kind": 32768, + "kindString": "Parameter", + "name": "request", + "type": { + "name": "Dict", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to add the request to the head or the end of the queue\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 378, + "kind": 32768, + "kindString": "Parameter", + "name": "forefront", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + }, + { + "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": 379, + "module": "clients.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\n" + }, + "returns": "dict, optional: The retrieved request, or None, if it did not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/request_queue.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 102 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict, optional: 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": 380, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get_request", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the request to retrieve\n" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 381, + "kind": 32768, + "kindString": "Parameter", + "name": "request_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + }, + { + "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": 382, + "module": "clients.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\n" + }, + "returns": "dict: The updated request" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/request_queue.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 126 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 383, + "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": 384, + "kind": 32768, + "kindString": "Parameter", + "name": "request", + "type": { + "name": "Dict", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to put the updated request in the beginning or the end of the queue\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 385, + "kind": 32768, + "kindString": "Parameter", + "name": "forefront", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + }, + { + "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": 386, + "module": "clients.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." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/request_queue.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 154 + } + ], + "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": 387, + "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": 388, + "kind": 32768, + "kindString": "Parameter", + "name": "request_id", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single request queue." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 360, + 375, + 370, + 386, + 365, + 379, + 372, + 367, + 382 + ], + "title": "Methods" + } + ], + "id": 359, + "module": "clients.resource_clients.request_queue", + "name": "RequestQueueClient", + "parsedDocstring": { + "text": "Sub-client for manipulating a single request queue." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/request_queue.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 8 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "681", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the LogClient." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 390, + "module": "clients.resource_clients.log", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the LogClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/log.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 12 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the LogClient." + } + ] + }, + "flags": {}, + "id": 391, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 392, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 393, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "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" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 394, + "module": "clients.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", + "returns": "str, optional: The retrieved log, or None, if it does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/log.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 17 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "str, optional: 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" + } + ] + }, + "flags": {}, + "id": 395, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as a file-like object.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 396, + "module": "clients.resource_clients.log", + "name": "stream", + "parsedDocstring": { + "text": "Retrieve the log as a file-like object.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n", + "returns": "io.IOBase, optional: The retrieved log as a file-like object, or None, if it does not exist." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/log.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 39 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "io.IOBase, optional: The retrieved log as a file-like object, or None, if it does not exist." + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the log as a file-like object.\n\nhttps://docs.apify.com/api/v2#/reference/logs/log/get-log\n" + } + ] + }, + "flags": {}, + "id": 397, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "stream", + "parameters": [], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "io.IOBase" + } + ] + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating logs." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 390, + 394, + 396 + ], + "title": "Methods" + } + ], + "id": 389, + "module": "clients.resource_clients.log", + "name": "LogClient", + "parsedDocstring": { + "text": "Sub-client for manipulating logs." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/log.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 9 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "681", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the KeyValueStoreCollectionClient with the passed arguments." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 399, + "module": "clients.resource_clients.key_value_store_collection", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the KeyValueStoreCollectionClient with the passed arguments." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/key_value_store_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 10 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the KeyValueStoreCollectionClient with the passed arguments." + } + ] + }, + "flags": {}, + "id": 400, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 401, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 402, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "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": 403, + "module": "clients.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\n" + }, + "returns": "ListPage: The list of available key-value stores matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/key_value_store_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 15 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "ListPage: 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": 404, + "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": 405, + "kind": 32768, + "kindString": "Parameter", + "name": "unnamed", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many key-value stores to retrieve" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 406, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "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": 407, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the key-value stores in descending order based on their modification date\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 408, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + } + ], + "type": { + "name": "ListPage", + "type": "reference", + "target": "95" + } + } + ] + }, + { + "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": 409, + "module": "clients.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.\n" + }, + "returns": "dict: The retrieved or newly-created key-value store." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/key_value_store_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 38 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 410, + "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.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 411, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating key-value stores." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 399, + 409, + 403 + ], + "title": "Methods" + } + ], + "id": 398, + "module": "clients.resource_clients.key_value_store_collection", + "name": "KeyValueStoreCollectionClient", + "parsedDocstring": { + "text": "Sub-client for manipulating key-value stores." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/key_value_store_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 7 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceCollectionClient", + "target": "680", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the KeyValueStoreClient." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 413, + "module": "clients.resource_clients.key_value_store", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the KeyValueStoreClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/key_value_store.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 11 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the KeyValueStoreClient." + } + ] + }, + "flags": {}, + "id": 414, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 415, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 416, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "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": 417, + "module": "clients.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", + "returns": "dict, optional: The retrieved key-value store, or None if it does not exist" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/key_value_store.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 16 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict, optional: 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": 418, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + }, + { + "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": 419, + "module": "clients.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\n" + }, + "returns": "dict: The updated key-value store" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/key_value_store.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 26 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 420, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new name for key-value store\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 421, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + }, + { + "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" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 422, + "module": "clients.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" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/key_value_store.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 43 + } + ], + "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" + } + ] + }, + "flags": {}, + "id": 423, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [], + "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": 424, + "module": "clients.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\n" + }, + "returns": "dict: The list of keys in the key-value store matching the given arguments" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/key_value_store.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 50 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 425, + "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": 426, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "All keys up to this one (including) are skipped from the result\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 427, + "kind": 32768, + "kindString": "Parameter", + "name": "exclusive_start_key", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + }, + { + "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": 428, + "module": "clients.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", + "as_bytes": "Whether to retrieve the record as unparsed bytes, default False", + "as_file": "Whether to retrieve the record as a file-like object, default False\n" + }, + "returns": "dict, optional: The requested record, or None, if the record does not exist" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/key_value_store.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 75 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict, optional: 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": 429, + "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": 430, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to retrieve the record as unparsed bytes, default False" + } + ] + }, + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 431, + "kind": 32768, + "kindString": "Parameter", + "name": "as_bytes", + "type": { + "name": "bool", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to retrieve the record as a file-like object, default False\n" + } + ] + }, + "defaultValue": "False", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 432, + "kind": 32768, + "kindString": "Parameter", + "name": "as_file", + "type": { + "name": "bool", + "type": "reference" + } + } + ], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + }, + { + "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": 433, + "module": "clients.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" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/key_value_store.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 112 + } + ], + "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": 434, + "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": 435, + "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": 436, + "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": false + }, + "id": 437, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "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": 438, + "module": "clients.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" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/key_value_store.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 134 + } + ], + "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": 439, + "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": 440, + "kind": 32768, + "kindString": "Parameter", + "name": "key", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single key-value store." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 413, + 422, + 438, + 417, + 428, + 424, + 433, + 419 + ], + "title": "Methods" + } + ], + "id": 412, + "module": "clients.resource_clients.key_value_store", + "name": "KeyValueStoreClient", + "parsedDocstring": { + "text": "Sub-client for manipulating a single key-value store." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/key_value_store.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 8 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "681", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the DatasetCollectionClient with the passed arguments." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 442, + "module": "clients.resource_clients.dataset_collection", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the DatasetCollectionClient with the passed arguments." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/dataset_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 10 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the DatasetCollectionClient with the passed arguments." + } + ] + }, + "flags": {}, + "id": 443, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 444, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 445, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "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": 446, + "module": "clients.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\n" + }, + "returns": "ListPage: The list of available datasets matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/dataset_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 15 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "ListPage: 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": 447, + "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": 448, + "kind": 32768, + "kindString": "Parameter", + "name": "unnamed", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many datasets to retrieve" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 449, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What dataset to include as first when retrieving the list" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 450, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the datasets in descending order based on their modification date\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 451, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + } + ], + "type": { + "name": "ListPage", + "type": "reference", + "target": "95" + } + } + ] + }, + { + "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": 452, + "module": "clients.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.\n" + }, + "returns": "dict: The retrieved or newly-created dataset." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/dataset_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 38 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 453, + "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.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 454, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating datasets." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 442, + 452, + 446 + ], + "title": "Methods" + } + ], + "id": 441, + "module": "clients.resource_clients.dataset_collection", + "name": "DatasetCollectionClient", + "parsedDocstring": { + "text": "Sub-client for manipulating datasets." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/dataset_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 7 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceCollectionClient", + "target": "680", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the DatasetClient." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 456, + "module": "clients.resource_clients.dataset", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the DatasetClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/dataset.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 12 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the DatasetClient." + } + ] + }, + "flags": {}, + "id": 457, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 458, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 459, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "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": 460, + "module": "clients.resource_clients.dataset", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/get-dataset\n", + "returns": "dict, optional: The retrieved dataset, or None, if it does not exist" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/dataset.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 17 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict, optional: 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": 461, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + }, + { + "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": 462, + "module": "clients.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\n" + }, + "returns": "dict: The updated dataset" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/dataset.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 27 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 463, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "update", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new name for the dataset\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 464, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + }, + { + "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" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 465, + "module": "clients.resource_clients.dataset", + "name": "delete", + "parsedDocstring": { + "text": "Delete the dataset.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/dataset/delete-dataset" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/dataset.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 44 + } + ], + "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" + } + ] + }, + "flags": {}, + "id": 466, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [], + "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": 467, + "module": "clients.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.\nTo reverse the order, set this parameter to True.", + "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with the # character).\nThe clean parameter is just a shortcut for skip_hidden=True and skip_empty=True parameters.\nNote that since some objects might be skipped from the output, that the result might contain less items than the limit value.", + "fields": "A list of fields which should be picked from the items,\nonly these fields will remain in the resulting record objects.\nNote that the fields in the outputted items are sorted the same way as they are specified in the fields parameter.\nYou can use this feature to effectively fix the output format.", + "omit": "A list of fields which should be omitted from the items.", + "unwind": "Name of a field which should be unwound.\nIf the field is an array then every element of the array will become a separate record and merged with parent object.\nIf the unwound field is an object then it is merged with the parent object.\nIf the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object,\nthen the item gets preserved as it is. Note that the unwound items ignore the desc parameter.", + "skip_empty": "If True, then empty items are skipped from the output.\nNote that if used, the results might contain less items than the limit value.", + "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with the # character.\n" + }, + "returns": "ListPage: A page of the list of dataset items according to the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/dataset.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 51 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "ListPage: 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": 468, + "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": 469, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "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": 470, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with the # character).\nThe clean parameter is just a shortcut for skip_hidden=True and skip_empty=True parameters.\nNote that since some objects might be skipped from the output, that the result might contain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 471, + "kind": 32768, + "kindString": "Parameter", + "name": "clean", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "By default, results are returned in the same order as they were stored.\nTo reverse the order, set this parameter to True." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 472, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be picked from the items,\nonly these fields will remain in the resulting record objects.\nNote that the fields in the outputted items are sorted the same way as they are specified in the fields parameter.\nYou can use this feature to effectively fix the output format." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 473, + "kind": 32768, + "kindString": "Parameter", + "name": "fields", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + ] + } + }, + { + "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": 474, + "kind": 32768, + "kindString": "Parameter", + "name": "omit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of a field which should be unwound.\nIf the field is an array then every element of the array will become a separate record and merged with parent object.\nIf the unwound field is an object then it is merged with the parent object.\nIf the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object,\nthen the item gets preserved as it is. Note that the unwound items ignore the desc parameter." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 475, + "kind": 32768, + "kindString": "Parameter", + "name": "unwind", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then empty items are skipped from the output.\nNote that if used, the results might contain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 476, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_empty", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with the # character.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 477, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_hidden", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + } + ], + "type": { + "name": "ListPage", + "type": "reference", + "target": "95" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "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" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 478, + "module": "clients.resource_clients.dataset", + "name": "iterate_items", + "parsedDocstring": { + "text": "Iterate over the items in 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.\nTo reverse the order, set this parameter to True.", + "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with the # character).\nThe clean parameter is just a shortcut for skip_hidden=True and skip_empty=True parameters.\nNote that since some objects might be skipped from the output, that the result might contain less items than the limit value.", + "fields": "A list of fields which should be picked from the items,\nonly these fields will remain in the resulting record objects.\nNote that the fields in the outputted items are sorted the same way as they are specified in the fields parameter.\nYou can use this feature to effectively fix the output format.", + "omit": "A list of fields which should be omitted from the items.", + "unwind": "Name of a field which should be unwound.\nIf the field is an array then every element of the array will become a separate record and merged with parent object.\nIf the unwound field is an object then it is merged with the parent object.\nIf the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object,\nthen the item gets preserved as it is. Note that the unwound items ignore the desc parameter.", + "skip_empty": "If True, then empty items are skipped from the output.\nNote that if used, the results might contain less items than the limit value.", + "skip_hidden": "If True, then hidden fields are skipped from the output, i.e. fields starting with the # character.\n" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/dataset.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 122 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "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" + } + ] + }, + "flags": {}, + "id": 479, + "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": "0", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 480, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "int", + "type": "reference" + } + }, + { + "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": 481, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with the # character).\nThe clean parameter is just a shortcut for skip_hidden=True and skip_empty=True parameters.\nNote that since some objects might be skipped from the output, that the result might contain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 482, + "kind": 32768, + "kindString": "Parameter", + "name": "clean", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "By default, results are returned in the same order as they were stored.\nTo reverse the order, set this parameter to True." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 483, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be picked from the items,\nonly these fields will remain in the resulting record objects.\nNote that the fields in the outputted items are sorted the same way as they are specified in the fields parameter.\nYou can use this feature to effectively fix the output format." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 484, + "kind": 32768, + "kindString": "Parameter", + "name": "fields", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + ] + } + }, + { + "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": 485, + "kind": 32768, + "kindString": "Parameter", + "name": "omit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of a field which should be unwound.\nIf the field is an array then every element of the array will become a separate record and merged with parent object.\nIf the unwound field is an object then it is merged with the parent object.\nIf the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object,\nthen the item gets preserved as it is. Note that the unwound items ignore the desc parameter." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 486, + "kind": 32768, + "kindString": "Parameter", + "name": "unwind", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then empty items are skipped from the output.\nNote that if used, the results might contain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 487, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_empty", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with the # character.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 488, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_hidden", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + } + ], + "type": { + "name": "Generator", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Download 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": 489, + "module": "clients.resource_clients.dataset", + "name": "download_items", + "parsedDocstring": { + "text": "Download 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. The 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.\nTo reverse the order, set this parameter to True.", + "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with the # character).\nThe clean parameter is just a shortcut for skip_hidden=True and skip_empty=True parameters.\nNote that since some objects might be skipped from the output, that the result might contain less items than the limit value.", + "bom": "All text responses are encoded in UTF-8 encoding.\nBy default, csv files are prefixed with the UTF-8 Byte Order Mark (BOM),\nwhile json, jsonl, xml, html and rss files are not. If you want to override this default behavior,\nspecify bom=True query parameter to include the BOM or bom=False to 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,\nonly these fields will remain in the resulting record objects.\nNote that the fields in the outputted items are sorted the same way as they are specified in the fields parameter.\nYou can use this feature to effectively fix the output format.", + "omit": "A list of fields which should be omitted from the items.", + "unwind": "Name of a field which should be unwound.\nIf the field is an array then every element of the array will become a separate record and merged with parent object.\nIf the unwound field is an object then it is merged with the parent object.\nIf the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object,\nthen the item gets preserved as it is. Note that the unwound items ignore the desc parameter.", + "skip_empty": "If True, then empty items are skipped from the output.\nNote that if used, the results might contain 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 the # 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.\n" + }, + "returns": "bytes: The dataset items as raw bytes" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/dataset.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 198 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "bytes: The dataset items as raw bytes" + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Download the items in the dataset as raw bytes.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "flags": {}, + "id": 490, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "download_items", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss. The default value is json." + } + ] + }, + "defaultValue": "'json'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 491, + "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": 492, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "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": 493, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "By default, results are returned in the same order as they were stored.\nTo reverse the order, set this parameter to True." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 494, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with the # character).\nThe clean parameter is just a shortcut for skip_hidden=True and skip_empty=True parameters.\nNote that since some objects might be skipped from the output, that the result might contain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 495, + "kind": 32768, + "kindString": "Parameter", + "name": "clean", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "All text responses are encoded in UTF-8 encoding.\nBy default, csv files are prefixed with the UTF-8 Byte Order Mark (BOM),\nwhile json, jsonl, xml, html and rss files are not. If you want to override this default behavior,\nspecify bom=True query parameter to include the BOM or bom=False to skip it." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 496, + "kind": 32768, + "kindString": "Parameter", + "name": "bom", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "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": 497, + "kind": 32768, + "kindString": "Parameter", + "name": "delimiter", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be picked from the items,\nonly these fields will remain in the resulting record objects.\nNote that the fields in the outputted items are sorted the same way as they are specified in the fields parameter.\nYou can use this feature to effectively fix the output format." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 498, + "kind": 32768, + "kindString": "Parameter", + "name": "fields", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + ] + } + }, + { + "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": 499, + "kind": 32768, + "kindString": "Parameter", + "name": "omit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of a field which should be unwound.\nIf the field is an array then every element of the array will become a separate record and merged with parent object.\nIf the unwound field is an object then it is merged with the parent object.\nIf the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object,\nthen the item gets preserved as it is. Note that the unwound items ignore the desc parameter." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 500, + "kind": 32768, + "kindString": "Parameter", + "name": "unwind", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then empty items are skipped from the output.\nNote that if used, the results might contain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 501, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_empty", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "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": 502, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_header_row", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with the # character." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 503, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_hidden", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "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": 504, + "kind": 32768, + "kindString": "Parameter", + "name": "xml_root", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "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.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 505, + "kind": 32768, + "kindString": "Parameter", + "name": "xml_row", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "bytes", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve the items in the dataset as a file-like object.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 506, + "module": "clients.resource_clients.dataset", + "name": "stream_items", + "parsedDocstring": { + "text": "Retrieve the items in the dataset as a file-like object.\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. The 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.\nTo reverse the order, set this parameter to True.", + "clean": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with the # character).\nThe clean parameter is just a shortcut for skip_hidden=True and skip_empty=True parameters.\nNote that since some objects might be skipped from the output, that the result might contain less items than the limit value.", + "bom": "All text responses are encoded in UTF-8 encoding.\nBy default, csv files are prefixed with the UTF-8 Byte Order Mark (BOM),\nwhile json, jsonl, xml, html and rss files are not. If you want to override this default behavior,\nspecify bom=True query parameter to include the BOM or bom=False to 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,\nonly these fields will remain in the resulting record objects.\nNote that the fields in the outputted items are sorted the same way as they are specified in the fields parameter.\nYou can use this feature to effectively fix the output format.", + "omit": "A list of fields which should be omitted from the items.", + "unwind": "Name of a field which should be unwound.\nIf the field is an array then every element of the array will become a separate record and merged with parent object.\nIf the unwound field is an object then it is merged with the parent object.\nIf the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object,\nthen the item gets preserved as it is. Note that the unwound items ignore the desc parameter.", + "skip_empty": "If True, then empty items are skipped from the output.\nNote that if used, the results might contain 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 the # 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.\n" + }, + "returns": "io.IOBase: The dataset items as a file-like object" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/dataset.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 283 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "io.IOBase: The dataset items as a file-like object" + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "Retrieve the items in the dataset as a file-like object.\n\nhttps://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items\n" + } + ] + }, + "flags": {}, + "id": 507, + "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. The default value is json." + } + ] + }, + "defaultValue": "'json'", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 508, + "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": 509, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "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": 510, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "By default, results are returned in the same order as they were stored.\nTo reverse the order, set this parameter to True." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 511, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, returns only non-empty items and skips hidden fields (i.e. fields starting with the # character).\nThe clean parameter is just a shortcut for skip_hidden=True and skip_empty=True parameters.\nNote that since some objects might be skipped from the output, that the result might contain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 512, + "kind": 32768, + "kindString": "Parameter", + "name": "clean", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "All text responses are encoded in UTF-8 encoding.\nBy default, csv files are prefixed with the UTF-8 Byte Order Mark (BOM),\nwhile json, jsonl, xml, html and rss files are not. If you want to override this default behavior,\nspecify bom=True query parameter to include the BOM or bom=False to skip it." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 513, + "kind": 32768, + "kindString": "Parameter", + "name": "bom", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "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": 514, + "kind": 32768, + "kindString": "Parameter", + "name": "delimiter", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of fields which should be picked from the items,\nonly these fields will remain in the resulting record objects.\nNote that the fields in the outputted items are sorted the same way as they are specified in the fields parameter.\nYou can use this feature to effectively fix the output format." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 515, + "kind": 32768, + "kindString": "Parameter", + "name": "fields", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + ] + } + }, + { + "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": 516, + "kind": 32768, + "kindString": "Parameter", + "name": "omit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of a field which should be unwound.\nIf the field is an array then every element of the array will become a separate record and merged with parent object.\nIf the unwound field is an object then it is merged with the parent object.\nIf the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object,\nthen the item gets preserved as it is. Note that the unwound items ignore the desc parameter." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 517, + "kind": 32768, + "kindString": "Parameter", + "name": "unwind", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then empty items are skipped from the output.\nNote that if used, the results might contain less items than the limit value." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 518, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_empty", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "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": 519, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_header_row", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If True, then hidden fields are skipped from the output, i.e. fields starting with the # character." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 520, + "kind": 32768, + "kindString": "Parameter", + "name": "skip_hidden", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "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": 521, + "kind": 32768, + "kindString": "Parameter", + "name": "xml_root", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "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.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 522, + "kind": 32768, + "kindString": "Parameter", + "name": "xml_row", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "io.IOBase", + "type": "reference" + } + } + ] + }, + { + "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": 523, + "module": "clients.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 of strings or dictionaries." + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/dataset.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 371 + } + ], + "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": 524, + "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 of strings or dictionaries." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 525, + "kind": 32768, + "kindString": "Parameter", + "name": "items", + "type": { + "name": "JSONSerializable", + "type": "reference", + "target": "105" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single dataset." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 456, + 465, + 489, + 460, + 478, + 467, + 523, + 506, + 462 + ], + "title": "Methods" + } + ], + "id": 455, + "module": "clients.resource_clients.dataset", + "name": "DatasetClient", + "parsedDocstring": { + "text": "Sub-client for manipulating a single dataset." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/dataset.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 9 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "681", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the BuildCollectionClient." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 527, + "module": "clients.resource_clients.build_collection", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the BuildCollectionClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/build_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 10 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the BuildCollectionClient." + } + ] + }, + "flags": {}, + "id": 528, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 529, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 530, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "type": "reference" + } + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "List all actor builds (either of a single actor, or all user's actors, depending on where this client was 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": 531, + "module": "clients.resource_clients.build_collection", + "name": "list", + "parsedDocstring": { + "text": "List all actor builds (either of a single actor, or all user's actors, depending on where this client was 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\n" + }, + "returns": "ListPage: The retrieved actor builds" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/build_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 15 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "ListPage: The retrieved actor builds" + } + ], + "tag": "@returns" + } + ], + "summary": [ + { + "kind": "text", + "text": "List all actor builds (either of a single actor, or all user's actors, depending on where this client was 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": 532, + "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": 533, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What build to include as first when retrieving the list" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 534, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the builds in descending order based on their start date\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 535, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + } + ], + "type": { + "name": "ListPage", + "type": "reference", + "target": "95" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for listing actor builds." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 527, + 531 + ], + "title": "Methods" + } + ], + "id": 526, + "module": "clients.resource_clients.build_collection", + "name": "BuildCollectionClient", + "parsedDocstring": { + "text": "Sub-client for listing actor builds." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/build_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 7 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceCollectionClient", + "target": "680", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the BuildClient." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 537, + "module": "clients.resource_clients.build", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the BuildClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/build.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 9 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the BuildClient." + } + ] + }, + "flags": {}, + "id": 538, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 539, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 540, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ActorJobBaseClient.__init__", + "target": 696, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ActorJobBaseClient.__init__", + "target": 696, + "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": 541, + "module": "clients.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", + "returns": "dict, optional: The retrieved actor build data" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/build.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 14 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict, optional: 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": 542, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + }, + { + "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": 543, + "module": "clients.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", + "returns": "dict: The data of the aborted actor build" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/build.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 24 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 544, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "abort", + "parameters": [], + "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": 545, + "module": "clients.resource_clients.build", + "name": "wait_for_finish", + "parsedDocstring": { + "text": "Wait synchronously until the build finishes or the server times out.\n", + "args": { + "wait_secs": "how long does the client wait for build to finish. None for indefinite.\n" + }, + "returns": "dict, optional: The actor build data. If the status on the object is not one of the terminal statuses\n(SUCEEDED, FAILED, TIMED_OUT, ABORTED), then the build has not yet finished." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/build.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 34 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict, optional: The actor build data. If the status on the object is not one of the terminal statuses\n(SUCEEDED, FAILED, TIMED_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": 546, + "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.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 547, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_secs", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + } + ], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single actor build." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 537, + 543, + 541, + 545 + ], + "title": "Methods" + } + ], + "id": 536, + "module": "clients.resource_clients.build", + "name": "BuildClient", + "parsedDocstring": { + "text": "Sub-client for manipulating a single actor build." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/build.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 6 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ActorJobBaseClient", + "target": "693", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the ActorVersionCollectionClient with the passed arguments." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 549, + "module": "clients.resource_clients.actor_version_collection", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the ActorVersionCollectionClient with the passed arguments." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor_version_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 11 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the ActorVersionCollectionClient with the passed arguments." + } + ] + }, + "flags": {}, + "id": 550, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 551, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 552, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "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": 553, + "module": "clients.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", + "returns": "ListPage: The list of available actor versions." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor_version_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 16 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "ListPage: 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": 554, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "list", + "parameters": [], + "type": { + "name": "ListPage", + "type": "reference", + "target": "95" + } + } + ] + }, + { + "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": 555, + "module": "clients.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,\nand optionally also 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\nwill also be 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.\nRequired when ``source_type`` is ``ActorSourceType.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 ``ActorSourceType.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 ``ActorSourceType.TARBALL``.", + "github_gist_url": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when ``source_type`` is ``ActorSourceType.GITHUB_GIST``.\n" + }, + "returns": "dict: The created actor version" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor_version_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 26 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 556, + "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": 557, + "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": 558, + "kind": 32768, + "kindString": "Parameter", + "name": "build_tag", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Environment variables that will be available to the actor run process,\nand optionally also to the build process. See the API docs for their exact structure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 559, + "kind": 32768, + "kindString": "Parameter", + "name": "env_vars", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the environment variables specified for the actor run\nwill also be set to the actor build process." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 560, + "kind": 32768, + "kindString": "Parameter", + "name": "apply_env_vars_to_build", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What source type is the actor version using." + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 561, + "kind": 32768, + "kindString": "Parameter", + "name": "source_type", + "type": { + "name": "ActorSourceType", + "type": "reference", + "target": "10" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Source code comprised of multiple files, each an item of the array.\nRequired when ``source_type`` is ``ActorSourceType.SOURCE_FILES``. See the API docs for the exact structure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 562, + "kind": 32768, + "kindString": "Parameter", + "name": "source_files", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of a Git repository from which the source code will be cloned.\nRequired when ``source_type`` is ``ActorSourceType.GIT_REPO``." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 563, + "kind": 32768, + "kindString": "Parameter", + "name": "git_repo_url", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "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 ``ActorSourceType.TARBALL``." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 564, + "kind": 32768, + "kindString": "Parameter", + "name": "tarball_url", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when ``source_type`` is ``ActorSourceType.GITHUB_GIST``.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 565, + "kind": 32768, + "kindString": "Parameter", + "name": "github_gist_url", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating actor versions." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 549, + 555, + 553 + ], + "title": "Methods" + } + ], + "id": 548, + "module": "clients.resource_clients.actor_version_collection", + "name": "ActorVersionCollectionClient", + "parsedDocstring": { + "text": "Sub-client for manipulating actor versions." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor_version_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 8 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceCollectionClient", + "target": "680", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the ActorVersionClient." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 567, + "module": "clients.resource_clients.actor_version", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the ActorVersionClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor_version.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 11 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the ActorVersionClient." + } + ] + }, + "flags": {}, + "id": 568, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 569, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 570, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "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": 571, + "module": "clients.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", + "returns": "dict, optional: The retrieved actor version data" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor_version.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 16 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict, optional: 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": 572, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + }, + { + "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": 573, + "module": "clients.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,\nand optionally also 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\nwill also be 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.\nRequired when ``source_type`` is ``ActorSourceType.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 ``ActorSourceType.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 ``ActorSourceType.TARBALL``.", + "github_gist_url": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when ``source_type`` is ``ActorSourceType.GITHUB_GIST``.\n" + }, + "returns": "dict: The updated actor version" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor_version.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 26 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 574, + "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": 575, + "kind": 32768, + "kindString": "Parameter", + "name": "build_tag", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Environment variables that will be available to the actor run process,\nand optionally also to the build process. See the API docs for their exact structure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 576, + "kind": 32768, + "kindString": "Parameter", + "name": "env_vars", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the environment variables specified for the actor run\nwill also be set to the actor build process." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 577, + "kind": 32768, + "kindString": "Parameter", + "name": "apply_env_vars_to_build", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What source type is the actor version using." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 578, + "kind": 32768, + "kindString": "Parameter", + "name": "source_type", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorSourceType", + "target": "10" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Source code comprised of multiple files, each an item of the array.\nRequired when ``source_type`` is ``ActorSourceType.SOURCE_FILES``. See the API docs for the exact structure." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 579, + "kind": 32768, + "kindString": "Parameter", + "name": "source_files", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of a Git repository from which the source code will be cloned.\nRequired when ``source_type`` is ``ActorSourceType.GIT_REPO``." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 580, + "kind": 32768, + "kindString": "Parameter", + "name": "git_repo_url", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "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 ``ActorSourceType.TARBALL``." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 581, + "kind": 32768, + "kindString": "Parameter", + "name": "tarball_url", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of a GitHub Gist from which the source will be downloaded.\nRequired when ``source_type`` is ``ActorSourceType.GITHUB_GIST``.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 582, + "kind": 32768, + "kindString": "Parameter", + "name": "github_gist_url", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + }, + { + "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" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 583, + "module": "clients.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" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor_version.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 81 + } + ], + "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" + } + ] + }, + "flags": {}, + "id": 584, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single actor version." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 567, + 583, + 571, + 573 + ], + "title": "Methods" + } + ], + "id": 566, + "module": "clients.resource_clients.actor_version", + "name": "ActorVersionClient", + "parsedDocstring": { + "text": "Sub-client for manipulating a single actor version." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor_version.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 8 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "681", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the ActorCollectionClient." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 586, + "module": "clients.resource_clients.actor_collection", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the ActorCollectionClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 10 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the ActorCollectionClient." + } + ] + }, + "flags": {}, + "id": 587, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 588, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 589, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceCollectionClient.__init__", + "target": 694, + "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": 590, + "module": "clients.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\n" + }, + "returns": "ListPage: The list of available actors matching the specified filters." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 15 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "ListPage: 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": 591, + "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": 592, + "kind": 32768, + "kindString": "Parameter", + "name": "my", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "How many actors to list" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 593, + "kind": 32768, + "kindString": "Parameter", + "name": "limit", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "What actor to include as first when retrieving the list" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 594, + "kind": 32768, + "kindString": "Parameter", + "name": "offset", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to sort the actors in descending order based on their creation date\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 595, + "kind": 32768, + "kindString": "Parameter", + "name": "desc", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + } + ], + "type": { + "name": "ListPage", + "type": "reference", + "target": "95" + } + } + ] + }, + { + "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": 596, + "module": "clients.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 main actor run process will be restarted whenever it exits with a non-zero status code.", + "is_public": "Whether the actor is public.", + "is_deprecated": "Whether the actor is deprecated.", + "is_anonymously_runnable": "Whether the actor is anonymously runnable.", + "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_memory_mbytes": "Default amount of memory allocated for the runs of this actor, in megabytes.", + "default_run_timeout_secs": "Default timeout for the runs of this actor in seconds.", + "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.\n" + }, + "returns": "dict: The created actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 38 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 597, + "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": 598, + "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": 599, + "kind": 32768, + "kindString": "Parameter", + "name": "title", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description for the actor" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 600, + "kind": 32768, + "kindString": "Parameter", + "name": "description", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the actor optimized for search engines" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 601, + "kind": 32768, + "kindString": "Parameter", + "name": "seo_title", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the actor optimized for search engines" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 602, + "kind": 32768, + "kindString": "Parameter", + "name": "seo_description", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of actor versions" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 603, + "kind": 32768, + "kindString": "Parameter", + "name": "versions", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the main actor run process will be restarted whenever it exits with a non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 604, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the actor is public." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 605, + "kind": 32768, + "kindString": "Parameter", + "name": "is_public", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the actor is deprecated." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 606, + "kind": 32768, + "kindString": "Parameter", + "name": "is_deprecated", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the actor is anonymously runnable." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 607, + "kind": 32768, + "kindString": "Parameter", + "name": "is_anonymously_runnable", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The categories to which the actor belongs to." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 608, + "kind": 32768, + "kindString": "Parameter", + "name": "categories", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + ] + } + }, + { + "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": 609, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_build", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "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": 610, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_memory_mbytes", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for the runs of this actor in seconds." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 611, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_timeout_secs", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "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": 612, + "kind": 32768, + "kindString": "Parameter", + "name": "example_run_input_body", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Any" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the example run input.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 613, + "kind": 32768, + "kindString": "Parameter", + "name": "example_run_input_content_type", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating actors." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 586, + 596, + 590 + ], + "title": "Methods" + } + ], + "id": 585, + "module": "clients.resource_clients.actor_collection", + "name": "ActorCollectionClient", + "parsedDocstring": { + "text": "Sub-client for manipulating actors." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor_collection.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 7 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceCollectionClient", + "target": "680", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the ActorClient." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 615, + "module": "clients.resource_clients.actor", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the ActorClient." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 23 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the ActorClient." + } + ] + }, + "flags": {}, + "id": 616, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 617, + "kind": 32768, + "kindString": "Parameter", + "name": "args", + "type": { + "name": "Any", + "type": "reference" + } + }, + { + "flags": { + "isOptional": false, + "keyword-only": false + }, + "id": 618, + "kind": 32768, + "kindString": "Parameter", + "name": "kwargs", + "type": { + "name": "Any", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + }, + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "type": "reference" + } + } + ], + "overwrites": { + "name": "ResourceClient.__init__", + "target": 695, + "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": 619, + "module": "clients.resource_clients.actor", + "name": "get", + "parsedDocstring": { + "text": "Retrieve the actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/get-actor\n", + "returns": "dict, optional: The retrieved actor" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 28 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict, optional: 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": 620, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "get", + "parameters": [], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + }, + { + "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": 621, + "module": "clients.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 main actor run process will be restarted whenever it exits with a non-zero status code.", + "is_public": "Whether the actor is public.", + "is_deprecated": "Whether the actor is deprecated.", + "is_anonymously_runnable": "Whether the actor is anonymously runnable.", + "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_memory_mbytes": "Default amount of memory allocated for the runs of this actor, in megabytes.", + "default_run_timeout_secs": "Default timeout for the runs of this actor in seconds.", + "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.\n" + }, + "returns": "dict: The updated actor" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 38 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 622, + "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": 623, + "kind": 32768, + "kindString": "Parameter", + "name": "name", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the actor (human-readable)" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 624, + "kind": 32768, + "kindString": "Parameter", + "name": "title", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description for the actor" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 625, + "kind": 32768, + "kindString": "Parameter", + "name": "description", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the actor optimized for search engines" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 626, + "kind": 32768, + "kindString": "Parameter", + "name": "seo_title", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the actor optimized for search engines" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 627, + "kind": 32768, + "kindString": "Parameter", + "name": "seo_description", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of actor versions" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 628, + "kind": 32768, + "kindString": "Parameter", + "name": "versions", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the main actor run process will be restarted whenever it exits with a non-zero status code." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 629, + "kind": 32768, + "kindString": "Parameter", + "name": "restart_on_error", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the actor is public." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 630, + "kind": 32768, + "kindString": "Parameter", + "name": "is_public", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the actor is deprecated." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 631, + "kind": 32768, + "kindString": "Parameter", + "name": "is_deprecated", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the actor is anonymously runnable." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 632, + "kind": 32768, + "kindString": "Parameter", + "name": "is_anonymously_runnable", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The categories to which the actor belongs to." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 633, + "kind": 32768, + "kindString": "Parameter", + "name": "categories", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + ] + } + }, + { + "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": 634, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_build", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "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": 635, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_memory_mbytes", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Default timeout for the runs of this actor in seconds." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 636, + "kind": 32768, + "kindString": "Parameter", + "name": "default_run_timeout_secs", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "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": 637, + "kind": 32768, + "kindString": "Parameter", + "name": "example_run_input_body", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Any" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the example run input.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 638, + "kind": 32768, + "kindString": "Parameter", + "name": "example_run_input_content_type", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + }, + { + "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" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 639, + "module": "clients.resource_clients.actor", + "name": "delete", + "parsedDocstring": { + "text": "Delete the actor.\n\nhttps://docs.apify.com/api/v2#/reference/actors/actor-object/delete-actor" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 127 + } + ], + "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" + } + ] + }, + "flags": {}, + "id": 640, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "delete", + "parameters": [], + "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": 641, + "module": "clients.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.\nBy default, the run uses the build specified in the default run configuration for the actor (typically latest).", + "memory_mbytes": "Memory limit for the run, in megabytes.\nBy default, the run uses a memory limit specified in the default run configuration for the actor.", + "timeout_secs": "Optional timeout for the run, in seconds.\nBy default, the run uses timeout specified in the default run configuration for the actor.", + "wait_for_finish": "The maximum number of seconds the server waits for the run to finish.\nBy default, it is 0, the maximum value is 300.", + "webhooks": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks)\nassociated with the actor run which can be used to receive a notification,\ne.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): Optional template for the request payload\n" + }, + "returns": "dict: The run object" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 134 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 642, + "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": 643, + "kind": 32768, + "kindString": "Parameter", + "name": "run_input", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Any" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the input." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 644, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the actor build to run. 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 actor (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 645, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes.\nBy default, the run uses a memory limit specified in the default run configuration for the actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 646, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run, in seconds.\nBy default, the run uses timeout specified in the default run configuration for the actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 647, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_secs", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of seconds the server waits for the run to finish.\nBy default, it is 0, the maximum value is 300." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 648, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_for_finish", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional ad-hoc webhooks (https://docs.apify.com/webhooks/ad-hoc-webhooks)\nassociated with the actor run which can be used to receive a notification,\ne.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): Optional template for the request payload\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 649, + "kind": 32768, + "kindString": "Parameter", + "name": "webhooks", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + }, + { + "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_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 650, + "module": "clients.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_secs 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.\nBy default, the run uses the build specified in the default run configuration for the actor (typically latest).", + "memory_mbytes": "Memory limit for the run, in megabytes.\nBy default, the run uses a memory limit specified in the default run configuration for the actor.", + "timeout_secs": "Optional timeout for the run, in seconds.\nBy default, the run uses timeout specified in the default run configuration for the actor.", + "webhooks": "Optional webhooks (https://docs.apify.com/webhooks) associated with the actor run,\nwhich 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, you do not have to add it again here.", + "wait_secs": "The maximum number of seconds the server waits for the run to finish. If not provided, waits indefinitely.\n" + }, + "returns": "dict: The run object" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 192 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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_secs argument is provided.\n\nhttps://docs.apify.com/api/v2#/reference/actors/run-collection/run-actor\n" + } + ] + }, + "flags": {}, + "id": 651, + "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": 652, + "kind": 32768, + "kindString": "Parameter", + "name": "run_input", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Any" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content type of the input." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 653, + "kind": 32768, + "kindString": "Parameter", + "name": "content_type", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies the actor build to run. 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 actor (typically latest)." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 654, + "kind": 32768, + "kindString": "Parameter", + "name": "build", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Memory limit for the run, in megabytes.\nBy default, the run uses a memory limit specified in the default run configuration for the actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 655, + "kind": 32768, + "kindString": "Parameter", + "name": "memory_mbytes", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional timeout for the run, in seconds.\nBy default, the run uses timeout specified in the default run configuration for the actor." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 656, + "kind": 32768, + "kindString": "Parameter", + "name": "timeout_secs", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional webhooks (https://docs.apify.com/webhooks) associated with the actor run,\nwhich 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, you do not have to add it again here." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 657, + "kind": 32768, + "kindString": "Parameter", + "name": "webhooks", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "List", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of seconds the server waits for the run to finish. If not provided, waits indefinitely.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 658, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_secs", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + } + ], + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ] + }, + { + "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": 659, + "module": "clients.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.\nBy default, the 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 buildTag 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.\nBy 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 300.\n" + }, + "returns": "dict: The build object" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 237 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "dict: 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": 660, + "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": 661, + "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.\nBy default, the build uses latest stable packages." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 662, + "kind": 32768, + "kindString": "Parameter", + "name": "beta_packages", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "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 buildTag property." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 663, + "kind": 32768, + "kindString": "Parameter", + "name": "tag", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "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.\nBy default, the cache is not used." + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 664, + "kind": 32768, + "kindString": "Parameter", + "name": "use_cache", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "bool" + } + ] + } + }, + { + "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 300.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 665, + "kind": 32768, + "kindString": "Parameter", + "name": "wait_for_finish", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "int" + } + ] + } + } + ], + "type": { + "name": "Dict", + "type": "reference" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the builds of this actor." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 666, + "module": "clients.resource_clients.actor", + "name": "builds", + "parsedDocstring": { + "text": "Retrieve a client for the builds of this actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 281 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the builds of this actor." + } + ] + }, + "flags": {}, + "id": 667, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "builds", + "parameters": [], + "type": { + "name": "BuildCollectionClient", + "type": "reference", + "target": "526" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this actor." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 668, + "module": "clients.resource_clients.actor", + "name": "runs", + "parsedDocstring": { + "text": "Retrieve a client for the runs of this actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 285 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the runs of this actor." + } + ] + }, + "flags": {}, + "id": 669, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "runs", + "parameters": [], + "type": { + "name": "RunCollectionClient", + "type": "reference", + "target": "305" + } + } + ] + }, + { + "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": 670, + "module": "clients.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.\n" + }, + "returns": "RunClient: The resource client for the last run of this actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 289 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "RunClient: 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": 671, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "last_run", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Consider only runs with this status.\n" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 672, + "kind": 32768, + "kindString": "Parameter", + "name": "status", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "ActorJobStatus", + "target": "1" + } + ] + } + } + ], + "type": { + "name": "RunClient", + "type": "reference", + "target": "316" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the versions of this actor." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 673, + "module": "clients.resource_clients.actor", + "name": "versions", + "parsedDocstring": { + "text": "Retrieve a client for the versions of this actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 306 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for the versions of this actor." + } + ] + }, + "flags": {}, + "id": 674, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "versions", + "parameters": [], + "type": { + "name": "ActorVersionCollectionClient", + "type": "reference", + "target": "548" + } + } + ] + }, + { + "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": 675, + "module": "clients.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": "ActorVersionClient: The resource client for the specified actor version." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 310 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "blockTags": [ + { + "content": [ + { + "kind": "text", + "text": "ActorVersionClient: 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": 676, + "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": 677, + "kind": 32768, + "kindString": "Parameter", + "name": "version_number", + "type": { + "name": "str", + "type": "reference" + } + } + ], + "type": { + "name": "ActorVersionClient", + "type": "reference", + "target": "566" + } + } + ] + }, + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this actor." + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 678, + "module": "clients.resource_clients.actor", + "name": "webhooks", + "parsedDocstring": { + "text": "Retrieve a client for webhooks associated with this actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 321 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve a client for webhooks associated with this actor." + } + ] + }, + "flags": {}, + "id": 679, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "webhooks", + "parameters": [], + "type": { + "name": "WebhookCollectionClient", + "type": "reference", + "target": "151" + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sub-client for manipulating a single actor." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 615, + 659, + 666, + 650, + 639, + 619, + 670, + 668, + 641, + 621, + 675, + 673, + 678 + ], + "title": "Methods" + } + ], + "id": 614, + "module": "clients.resource_clients.actor", + "name": "ActorClient", + "parsedDocstring": { + "text": "Sub-client for manipulating a single actor." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/resource_clients/actor.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 20 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "681", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the sub-client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 694, + "module": "clients.base.base_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the sub-client.\n", + "args": { + "base_url": "Base URL of the API server", + "root_client": "The ApifyClient instance under which this resource client exists", + "http_client": "The _HTTPClient instance to be used in this client", + "resource_id": "ID of the manipulated resource, in case of a single-resource client", + "resource_path": "Path to the resource's endpoint on the API server", + "params": "Parameters to include in all requests from this client" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/base/base_client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 16 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the sub-client.\n" + } + ] + }, + "flags": {}, + "id": 684, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base URL of the API server" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 685, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ApifyClient instance under which this resource client exists" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 686, + "kind": 32768, + "kindString": "Parameter", + "name": "root_client", + "type": { + "name": "ApifyClient", + "type": "reference", + "target": "24" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The _HTTPClient instance to be used in this client" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 687, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "_HTTPClient", + "type": "reference", + "target": "108" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the manipulated resource, in case of a single-resource client" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 688, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "Optional[str]", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Path to the resource's endpoint on the API server" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 689, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters to include in all requests from this client" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 690, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "Optional[Dict]", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "reference" + }, + "inheritedFrom": { + "name": "BaseClient.__init__", + "target": 683, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "BaseClient.__init__", + "target": 683, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for sub-clients manipulating a resource collection." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 694 + ], + "title": "Methods" + } + ], + "id": 680, + "module": "clients.base.resource_collection_client", + "name": "ResourceCollectionClient", + "parsedDocstring": { + "text": "Base class for sub-clients manipulating a resource collection." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/base/resource_collection_client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 7 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "BaseClient", + "target": "682", + "type": "reference" + } + ], + "extendedBy": [ + { + "name": "WebhookDispatchCollectionClient", + "target": "134", + "type": "reference" + }, + { + "name": "WebhookCollectionClient", + "target": "151", + "type": "reference" + }, + { + "name": "TaskCollectionClient", + "target": "204", + "type": "reference" + }, + { + "name": "ScheduleCollectionClient", + "target": "266", + "type": "reference" + }, + { + "name": "RunCollectionClient", + "target": "305", + "type": "reference" + }, + { + "name": "RequestQueueCollectionClient", + "target": "345", + "type": "reference" + }, + { + "name": "KeyValueStoreCollectionClient", + "target": "398", + "type": "reference" + }, + { + "name": "DatasetCollectionClient", + "target": "441", + "type": "reference" + }, + { + "name": "BuildCollectionClient", + "target": "526", + "type": "reference" + }, + { + "name": "ActorVersionCollectionClient", + "target": "548", + "type": "reference" + }, + { + "name": "ActorCollectionClient", + "target": "585", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the sub-client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 695, + "module": "clients.base.base_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the sub-client.\n", + "args": { + "base_url": "Base URL of the API server", + "root_client": "The ApifyClient instance under which this resource client exists", + "http_client": "The _HTTPClient instance to be used in this client", + "resource_id": "ID of the manipulated resource, in case of a single-resource client", + "resource_path": "Path to the resource's endpoint on the API server", + "params": "Parameters to include in all requests from this client" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/base/base_client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 16 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the sub-client.\n" + } + ] + }, + "flags": {}, + "id": 684, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base URL of the API server" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 685, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ApifyClient instance under which this resource client exists" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 686, + "kind": 32768, + "kindString": "Parameter", + "name": "root_client", + "type": { + "name": "ApifyClient", + "type": "reference", + "target": "24" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The _HTTPClient instance to be used in this client" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 687, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "_HTTPClient", + "type": "reference", + "target": "108" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the manipulated resource, in case of a single-resource client" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 688, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "Optional[str]", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Path to the resource's endpoint on the API server" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 689, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters to include in all requests from this client" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 690, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "Optional[Dict]", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "reference" + }, + "inheritedFrom": { + "name": "BaseClient.__init__", + "target": 683, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "BaseClient.__init__", + "target": 683, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for sub-clients manipulating a single resource." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 695 + ], + "title": "Methods" + } + ], + "id": 681, + "module": "clients.base.resource_client", + "name": "ResourceClient", + "parsedDocstring": { + "text": "Base class for sub-clients manipulating a single resource." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/base/resource_client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 8 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "BaseClient", + "target": "682", + "type": "reference" + } + ], + "extendedBy": [ + { + "name": "WebhookDispatchClient", + "target": "144", + "type": "reference" + }, + { + "name": "WebhookClient", + "target": "173", + "type": "reference" + }, + { + "name": "UserClient", + "target": "197", + "type": "reference" + }, + { + "name": "TaskClient", + "target": "222", + "type": "reference" + }, + { + "name": "ScheduleClient", + "target": "285", + "type": "reference" + }, + { + "name": "RequestQueueClient", + "target": "359", + "type": "reference" + }, + { + "name": "LogClient", + "target": "389", + "type": "reference" + }, + { + "name": "KeyValueStoreClient", + "target": "412", + "type": "reference" + }, + { + "name": "DatasetClient", + "target": "455", + "type": "reference" + }, + { + "name": "ActorVersionClient", + "target": "566", + "type": "reference" + }, + { + "name": "ActorClient", + "target": "614", + "type": "reference" + }, + { + "name": "ActorJobBaseClient", + "target": "693", + "type": "reference" + } + ] + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the sub-client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 683, + "module": "clients.base.base_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the sub-client.\n", + "args": { + "base_url": "Base URL of the API server", + "root_client": "The ApifyClient instance under which this resource client exists", + "http_client": "The _HTTPClient instance to be used in this client", + "resource_id": "ID of the manipulated resource, in case of a single-resource client", + "resource_path": "Path to the resource's endpoint on the API server", + "params": "Parameters to include in all requests from this client" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/base/base_client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 16 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the sub-client.\n" + } + ] + }, + "flags": {}, + "id": 684, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base URL of the API server" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 685, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ApifyClient instance under which this resource client exists" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 686, + "kind": 32768, + "kindString": "Parameter", + "name": "root_client", + "type": { + "name": "ApifyClient", + "type": "reference", + "target": "24" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The _HTTPClient instance to be used in this client" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 687, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "_HTTPClient", + "type": "reference", + "target": "108" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the manipulated resource, in case of a single-resource client" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 688, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "str" + } + ] + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Path to the resource's endpoint on the API server" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 689, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters to include in all requests from this client" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 690, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "Optional", + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "Dict" + } + ] + } + } + ], + "type": { + "name": "None", + "type": "literal", + "value": null + } + } + ] + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base class for sub-clients." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 683 + ], + "title": "Methods" + } + ], + "id": 682, + "module": "clients.base.base_client", + "name": "BaseClient", + "parsedDocstring": { + "text": "Base class for sub-clients." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/base/base_client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 13 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedBy": [ + { + "name": "ResourceCollectionClient", + "target": "680", + "type": "reference" + }, + { + "name": "ResourceClient", + "target": "681", + "type": "reference" + } + ] + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 691, + "module": "clients.base.actor_job_base_client", + "name": "DEFAULT_WAIT_FOR_FINISH_SEC", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/base/actor_job_base_client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 11 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 1024, + "kindString": "Property", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "" + } + ] + }, + "flags": {}, + "groups": [], + "id": 692, + "module": "clients.base.actor_job_base_client", + "name": "DEFAULT_WAIT_WHEN_JOB_NOT_EXIST_SEC", + "parsedDocstring": { + "text": "" + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/base/actor_job_base_client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 14 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + } + }, + { + "kind": 128, + "kindString": "Class", + "children": [ + { + "kind": 2048, + "kindString": "Method", + "children": [], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the sub-client.\n" + } + ] + }, + "decorations": [], + "flags": {}, + "groups": [], + "id": 696, + "module": "clients.base.base_client", + "name": "__init__", + "parsedDocstring": { + "text": "Initialize the sub-client.\n", + "args": { + "base_url": "Base URL of the API server", + "root_client": "The ApifyClient instance under which this resource client exists", + "http_client": "The _HTTPClient instance to be used in this client", + "resource_id": "ID of the manipulated resource, in case of a single-resource client", + "resource_path": "Path to the resource's endpoint on the API server", + "params": "Parameters to include in all requests from this client" + } + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/base/base_client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 16 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "signatures": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Initialize the sub-client.\n" + } + ] + }, + "flags": {}, + "id": 684, + "kind": 4096, + "kindString": "Call signature", + "modifiers": [], + "name": "__init__", + "parameters": [ + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base URL of the API server" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 685, + "kind": 32768, + "kindString": "Parameter", + "name": "base_url", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ApifyClient instance under which this resource client exists" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 686, + "kind": 32768, + "kindString": "Parameter", + "name": "root_client", + "type": { + "name": "ApifyClient", + "type": "reference", + "target": "24" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "The _HTTPClient instance to be used in this client" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 687, + "kind": 32768, + "kindString": "Parameter", + "name": "http_client", + "type": { + "name": "_HTTPClient", + "type": "reference", + "target": "108" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the manipulated resource, in case of a single-resource client" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 688, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_id", + "type": { + "name": "Optional[str]", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Path to the resource's endpoint on the API server" + } + ] + }, + "flags": { + "isOptional": false, + "keyword-only": true + }, + "id": 689, + "kind": 32768, + "kindString": "Parameter", + "name": "resource_path", + "type": { + "name": "str", + "type": "reference" + } + }, + { + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters to include in all requests from this client" + } + ] + }, + "defaultValue": "None", + "flags": { + "isOptional": true, + "keyword-only": true + }, + "id": 690, + "kind": 32768, + "kindString": "Parameter", + "name": "params", + "type": { + "name": "Optional[Dict]", + "type": "reference" + } + } + ], + "type": { + "name": "None", + "type": "reference" + }, + "inheritedFrom": { + "name": "BaseClient.__init__", + "target": 683, + "type": "reference" + } + } + ], + "inheritedFrom": { + "name": "BaseClient.__init__", + "target": 683, + "type": "reference" + } + } + ], + "comment": { + "summary": [ + { + "kind": "text", + "text": "Base sub-client class for actor runs and actor builds." + } + ] + }, + "flags": {}, + "groups": [ + { + "children": [ + 696 + ], + "title": "Methods" + } + ], + "id": 693, + "module": "clients.base.actor_job_base_client", + "name": "ActorJobBaseClient", + "parsedDocstring": { + "text": "Base sub-client class for actor runs and actor builds." + }, + "sources": [ + { + "character": 1, + "fileName": "/src/apify_client/clients/base/actor_job_base_client.py", + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003", + "line": 17 + } + ], + "type": { + "name": "Undefined", + "type": "reference" + }, + "extendedTypes": [ + { + "name": "ResourceClient", + "target": "681", + "type": "reference" + } + ], + "extendedBy": [ + { + "name": "RunClient", + "target": "316", + "type": "reference" + }, + { + "name": "BuildClient", + "target": "536", + "type": "reference" + } + ] + } + ], + "flags": {}, + "groups": [ + { + "children": [ + 108, + 614, + 585, + 693, + 566, + 548, + 24, + 682, + 536, + 526, + 455, + 441, + 412, + 398, + 95, + 389, + 359, + 345, + 681, + 680, + 316, + 305, + 285, + 266, + 222, + 204, + 197, + 173, + 151, + 144, + 134 + ], + "title": "Classes" + }, + { + "children": [ + 125, + 124, + 130 + ], + "title": "Errors" + }, + { + "children": [ + 88, + 23, + 94, + 22, + 106, + 107, + 691, + 692, + 105, + 92, + 91, + 90, + 89, + 93 + ], + "title": "Properties" + }, + { + "children": [ + 1, + 10, + 15 + ], + "title": "Constants" + } + ], + "id": 0, + "kind": 1, + "kindString": "Project", + "name": "apify-client", + "sources": [ + { + "character": 0, + "fileName": "src/index.ts", + "line": 1, + "gitRevision": "b599baf2cf5bfa642169a11f431d78d1932a5003" + } + ], + "symbolIdMap": { + "1": { + "qualifiedName": "ActorJobStatus", + "sourceFileName": "/src/apify_client/consts.py" + }, + "2": { + "qualifiedName": "READY", + "sourceFileName": "/src/apify_client/consts.py" + }, + "3": { + "qualifiedName": "RUNNING", + "sourceFileName": "/src/apify_client/consts.py" + }, + "4": { + "qualifiedName": "SUCCEEDED", + "sourceFileName": "/src/apify_client/consts.py" + }, + "5": { + "qualifiedName": "FAILED", + "sourceFileName": "/src/apify_client/consts.py" + }, + "6": { + "qualifiedName": "TIMING_OUT", + "sourceFileName": "/src/apify_client/consts.py" + }, + "7": { + "qualifiedName": "TIMED_OUT", + "sourceFileName": "/src/apify_client/consts.py" + }, + "8": { + "qualifiedName": "ABORTING", + "sourceFileName": "/src/apify_client/consts.py" + }, + "9": { + "qualifiedName": "ABORTED", + "sourceFileName": "/src/apify_client/consts.py" + }, + "10": { + "qualifiedName": "ActorSourceType", + "sourceFileName": "/src/apify_client/consts.py" + }, + "11": { + "qualifiedName": "SOURCE_FILES", + "sourceFileName": "/src/apify_client/consts.py" + }, + "12": { + "qualifiedName": "GIT_REPO", + "sourceFileName": "/src/apify_client/consts.py" + }, + "13": { + "qualifiedName": "TARBALL", + "sourceFileName": "/src/apify_client/consts.py" + }, + "14": { + "qualifiedName": "GITHUB_GIST", + "sourceFileName": "/src/apify_client/consts.py" + }, + "15": { + "qualifiedName": "WebhookEventType", + "sourceFileName": "/src/apify_client/consts.py" + }, + "16": { + "qualifiedName": "ACTOR_RUN_CREATED", + "sourceFileName": "/src/apify_client/consts.py" + }, + "17": { + "qualifiedName": "ACTOR_RUN_SUCCEEDED", + "sourceFileName": "/src/apify_client/consts.py" + }, + "18": { + "qualifiedName": "ACTOR_RUN_FAILED", + "sourceFileName": "/src/apify_client/consts.py" + }, + "19": { + "qualifiedName": "ACTOR_RUN_TIMED_OUT", + "sourceFileName": "/src/apify_client/consts.py" + }, + "20": { + "qualifiedName": "ACTOR_RUN_ABORTED", + "sourceFileName": "/src/apify_client/consts.py" + }, + "21": { + "qualifiedName": "ACTOR_RUN_RESURRECTED", + "sourceFileName": "/src/apify_client/consts.py" + }, + "22": { + "qualifiedName": "DEFAULT_API_URL", + "sourceFileName": "/src/apify_client/client.py" + }, + "23": { + "qualifiedName": "API_VERSION", + "sourceFileName": "/src/apify_client/client.py" + }, + "24": { + "qualifiedName": "ApifyClient", + "sourceFileName": "/src/apify_client/client.py" + }, + "25": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/client.py" + }, + "31": { + "qualifiedName": "actor", + "sourceFileName": "/src/apify_client/client.py" + }, + "34": { + "qualifiedName": "actors", + "sourceFileName": "/src/apify_client/client.py" + }, + "36": { + "qualifiedName": "build", + "sourceFileName": "/src/apify_client/client.py" + }, + "39": { + "qualifiedName": "builds", + "sourceFileName": "/src/apify_client/client.py" + }, + "41": { + "qualifiedName": "run", + "sourceFileName": "/src/apify_client/client.py" + }, + "44": { + "qualifiedName": "runs", + "sourceFileName": "/src/apify_client/client.py" + }, + "46": { + "qualifiedName": "dataset", + "sourceFileName": "/src/apify_client/client.py" + }, + "49": { + "qualifiedName": "datasets", + "sourceFileName": "/src/apify_client/client.py" + }, + "51": { + "qualifiedName": "key_value_store", + "sourceFileName": "/src/apify_client/client.py" + }, + "54": { + "qualifiedName": "key_value_stores", + "sourceFileName": "/src/apify_client/client.py" + }, + "56": { + "qualifiedName": "request_queue", + "sourceFileName": "/src/apify_client/client.py" + }, + "60": { + "qualifiedName": "request_queues", + "sourceFileName": "/src/apify_client/client.py" + }, + "62": { + "qualifiedName": "webhook", + "sourceFileName": "/src/apify_client/client.py" + }, + "65": { + "qualifiedName": "webhooks", + "sourceFileName": "/src/apify_client/client.py" + }, + "67": { + "qualifiedName": "webhook_dispatch", + "sourceFileName": "/src/apify_client/client.py" + }, + "70": { + "qualifiedName": "webhook_dispatches", + "sourceFileName": "/src/apify_client/client.py" + }, + "72": { + "qualifiedName": "schedule", + "sourceFileName": "/src/apify_client/client.py" + }, + "75": { + "qualifiedName": "schedules", + "sourceFileName": "/src/apify_client/client.py" + }, + "77": { + "qualifiedName": "log", + "sourceFileName": "/src/apify_client/client.py" + }, + "80": { + "qualifiedName": "task", + "sourceFileName": "/src/apify_client/client.py" + }, + "83": { + "qualifiedName": "tasks", + "sourceFileName": "/src/apify_client/client.py" + }, + "85": { + "qualifiedName": "user", + "sourceFileName": "/src/apify_client/client.py" + }, + "88": { + "qualifiedName": "__version__", + "sourceFileName": "/src/apify_client/_version.py" + }, + "89": { + "qualifiedName": "PARSE_DATE_FIELDS_MAX_DEPTH", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "90": { + "qualifiedName": "PARSE_DATE_FIELDS_KEY_SUFFIX", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "91": { + "qualifiedName": "NOT_FOUND_TYPE", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "92": { + "qualifiedName": "NOT_FOUND_ON_S3", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "93": { + "qualifiedName": "T", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "94": { + "qualifiedName": "BailType", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "95": { + "qualifiedName": "ListPage", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "96": { + "qualifiedName": "items", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "97": { + "qualifiedName": "count", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "98": { + "qualifiedName": "offset", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "99": { + "qualifiedName": "limit", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "100": { + "qualifiedName": "total", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "101": { + "qualifiedName": "desc", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "102": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_utils.py" + }, + "105": { + "qualifiedName": "JSONSerializable", + "sourceFileName": "/src/apify_client/_types.py" + }, + "106": { + "qualifiedName": "DEFAULT_BACKOFF_EXPONENTIAL_FACTOR", + "sourceFileName": "/src/apify_client/_http_client.py" + }, + "107": { + "qualifiedName": "DEFAULT_BACKOFF_RANDOM_FACTOR", + "sourceFileName": "/src/apify_client/_http_client.py" + }, + "108": { + "qualifiedName": "_HTTPClient", + "sourceFileName": "/src/apify_client/_http_client.py" + }, + "109": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_http_client.py" + }, + "114": { + "qualifiedName": "call", + "sourceFileName": "/src/apify_client/_http_client.py" + }, + "124": { + "qualifiedName": "ApifyClientError", + "sourceFileName": "/src/apify_client/_errors.py" + }, + "125": { + "qualifiedName": "ApifyApiError", + "sourceFileName": "/src/apify_client/_errors.py" + }, + "126": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_errors.py" + }, + "130": { + "qualifiedName": "InvalidResponseBodyError", + "sourceFileName": "/src/apify_client/_errors.py" + }, + "131": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/_errors.py" + }, + "134": { + "qualifiedName": "WebhookDispatchCollectionClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py" + }, + "135": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py" + }, + "139": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/clients/resource_clients/webhook_dispatch_collection.py" + }, + "144": { + "qualifiedName": "WebhookDispatchClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/webhook_dispatch.py" + }, + "145": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/webhook_dispatch.py" + }, + "149": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/clients/resource_clients/webhook_dispatch.py" + }, + "151": { + "qualifiedName": "WebhookCollectionClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/webhook_collection.py" + }, + "152": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/webhook_collection.py" + }, + "156": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/clients/resource_clients/webhook_collection.py" + }, + "161": { + "qualifiedName": "create", + "sourceFileName": "/src/apify_client/clients/resource_clients/webhook_collection.py" + }, + "173": { + "qualifiedName": "WebhookClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/webhook.py" + }, + "174": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/webhook.py" + }, + "178": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/clients/resource_clients/webhook.py" + }, + "180": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/clients/resource_clients/webhook.py" + }, + "191": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/clients/resource_clients/webhook.py" + }, + "193": { + "qualifiedName": "test", + "sourceFileName": "/src/apify_client/clients/resource_clients/webhook.py" + }, + "195": { + "qualifiedName": "dispatches", + "sourceFileName": "/src/apify_client/clients/resource_clients/webhook.py" + }, + "197": { + "qualifiedName": "UserClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/user.py" + }, + "198": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/user.py" + }, + "202": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/clients/resource_clients/user.py" + }, + "204": { + "qualifiedName": "TaskCollectionClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/task_collection.py" + }, + "205": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/task_collection.py" + }, + "209": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/clients/resource_clients/task_collection.py" + }, + "214": { + "qualifiedName": "create", + "sourceFileName": "/src/apify_client/clients/resource_clients/task_collection.py" + }, + "222": { + "qualifiedName": "TaskClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/task.py" + }, + "223": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/task.py" + }, + "227": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/clients/resource_clients/task.py" + }, + "229": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/clients/resource_clients/task.py" + }, + "236": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/clients/resource_clients/task.py" + }, + "238": { + "qualifiedName": "start", + "sourceFileName": "/src/apify_client/clients/resource_clients/task.py" + }, + "246": { + "qualifiedName": "call", + "sourceFileName": "/src/apify_client/clients/resource_clients/task.py" + }, + "254": { + "qualifiedName": "get_input", + "sourceFileName": "/src/apify_client/clients/resource_clients/task.py" + }, + "256": { + "qualifiedName": "update_input", + "sourceFileName": "/src/apify_client/clients/resource_clients/task.py" + }, + "259": { + "qualifiedName": "runs", + "sourceFileName": "/src/apify_client/clients/resource_clients/task.py" + }, + "261": { + "qualifiedName": "last_run", + "sourceFileName": "/src/apify_client/clients/resource_clients/task.py" + }, + "264": { + "qualifiedName": "webhooks", + "sourceFileName": "/src/apify_client/clients/resource_clients/task.py" + }, + "266": { + "qualifiedName": "ScheduleCollectionClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/schedule_collection.py" + }, + "267": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/schedule_collection.py" + }, + "271": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/clients/resource_clients/schedule_collection.py" + }, + "276": { + "qualifiedName": "create", + "sourceFileName": "/src/apify_client/clients/resource_clients/schedule_collection.py" + }, + "285": { + "qualifiedName": "ScheduleClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/schedule.py" + }, + "286": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/schedule.py" + }, + "290": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/clients/resource_clients/schedule.py" + }, + "292": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/clients/resource_clients/schedule.py" + }, + "301": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/clients/resource_clients/schedule.py" + }, + "303": { + "qualifiedName": "get_log", + "sourceFileName": "/src/apify_client/clients/resource_clients/schedule.py" + }, + "305": { + "qualifiedName": "RunCollectionClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/run_collection.py" + }, + "306": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/run_collection.py" + }, + "310": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/clients/resource_clients/run_collection.py" + }, + "316": { + "qualifiedName": "RunClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/run.py" + }, + "317": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/run.py" + }, + "321": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/clients/resource_clients/run.py" + }, + "323": { + "qualifiedName": "abort", + "sourceFileName": "/src/apify_client/clients/resource_clients/run.py" + }, + "326": { + "qualifiedName": "wait_for_finish", + "sourceFileName": "/src/apify_client/clients/resource_clients/run.py" + }, + "329": { + "qualifiedName": "metamorph", + "sourceFileName": "/src/apify_client/clients/resource_clients/run.py" + }, + "335": { + "qualifiedName": "resurrect", + "sourceFileName": "/src/apify_client/clients/resource_clients/run.py" + }, + "337": { + "qualifiedName": "dataset", + "sourceFileName": "/src/apify_client/clients/resource_clients/run.py" + }, + "339": { + "qualifiedName": "key_value_store", + "sourceFileName": "/src/apify_client/clients/resource_clients/run.py" + }, + "341": { + "qualifiedName": "request_queue", + "sourceFileName": "/src/apify_client/clients/resource_clients/run.py" + }, + "343": { + "qualifiedName": "log", + "sourceFileName": "/src/apify_client/clients/resource_clients/run.py" + }, + "345": { + "qualifiedName": "RequestQueueCollectionClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/request_queue_collection.py" + }, + "346": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/request_queue_collection.py" + }, + "350": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/clients/resource_clients/request_queue_collection.py" + }, + "356": { + "qualifiedName": "get_or_create", + "sourceFileName": "/src/apify_client/clients/resource_clients/request_queue_collection.py" + }, + "359": { + "qualifiedName": "RequestQueueClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/request_queue.py" + }, + "360": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/request_queue.py" + }, + "365": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/clients/resource_clients/request_queue.py" + }, + "367": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/clients/resource_clients/request_queue.py" + }, + "370": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/clients/resource_clients/request_queue.py" + }, + "372": { + "qualifiedName": "list_head", + "sourceFileName": "/src/apify_client/clients/resource_clients/request_queue.py" + }, + "375": { + "qualifiedName": "add_request", + "sourceFileName": "/src/apify_client/clients/resource_clients/request_queue.py" + }, + "379": { + "qualifiedName": "get_request", + "sourceFileName": "/src/apify_client/clients/resource_clients/request_queue.py" + }, + "382": { + "qualifiedName": "update_request", + "sourceFileName": "/src/apify_client/clients/resource_clients/request_queue.py" + }, + "386": { + "qualifiedName": "delete_request", + "sourceFileName": "/src/apify_client/clients/resource_clients/request_queue.py" + }, + "389": { + "qualifiedName": "LogClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/log.py" + }, + "390": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/log.py" + }, + "394": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/clients/resource_clients/log.py" + }, + "396": { + "qualifiedName": "stream", + "sourceFileName": "/src/apify_client/clients/resource_clients/log.py" + }, + "398": { + "qualifiedName": "KeyValueStoreCollectionClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/key_value_store_collection.py" + }, + "399": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/key_value_store_collection.py" + }, + "403": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/clients/resource_clients/key_value_store_collection.py" + }, + "409": { + "qualifiedName": "get_or_create", + "sourceFileName": "/src/apify_client/clients/resource_clients/key_value_store_collection.py" + }, + "412": { + "qualifiedName": "KeyValueStoreClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/key_value_store.py" + }, + "413": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/key_value_store.py" + }, + "417": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/clients/resource_clients/key_value_store.py" + }, + "419": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/clients/resource_clients/key_value_store.py" + }, + "422": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/clients/resource_clients/key_value_store.py" + }, + "424": { + "qualifiedName": "list_keys", + "sourceFileName": "/src/apify_client/clients/resource_clients/key_value_store.py" + }, + "428": { + "qualifiedName": "get_record", + "sourceFileName": "/src/apify_client/clients/resource_clients/key_value_store.py" + }, + "433": { + "qualifiedName": "set_record", + "sourceFileName": "/src/apify_client/clients/resource_clients/key_value_store.py" + }, + "438": { + "qualifiedName": "delete_record", + "sourceFileName": "/src/apify_client/clients/resource_clients/key_value_store.py" + }, + "441": { + "qualifiedName": "DatasetCollectionClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/dataset_collection.py" + }, + "442": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/dataset_collection.py" + }, + "446": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/clients/resource_clients/dataset_collection.py" + }, + "452": { + "qualifiedName": "get_or_create", + "sourceFileName": "/src/apify_client/clients/resource_clients/dataset_collection.py" + }, + "455": { + "qualifiedName": "DatasetClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/dataset.py" + }, + "456": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/dataset.py" + }, + "460": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/clients/resource_clients/dataset.py" + }, + "462": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/clients/resource_clients/dataset.py" + }, + "465": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/clients/resource_clients/dataset.py" + }, + "467": { + "qualifiedName": "list_items", + "sourceFileName": "/src/apify_client/clients/resource_clients/dataset.py" + }, + "478": { + "qualifiedName": "iterate_items", + "sourceFileName": "/src/apify_client/clients/resource_clients/dataset.py" + }, + "489": { + "qualifiedName": "download_items", + "sourceFileName": "/src/apify_client/clients/resource_clients/dataset.py" + }, + "506": { + "qualifiedName": "stream_items", + "sourceFileName": "/src/apify_client/clients/resource_clients/dataset.py" + }, + "523": { + "qualifiedName": "push_items", + "sourceFileName": "/src/apify_client/clients/resource_clients/dataset.py" + }, + "526": { + "qualifiedName": "BuildCollectionClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/build_collection.py" + }, + "527": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/build_collection.py" + }, + "531": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/clients/resource_clients/build_collection.py" + }, + "536": { + "qualifiedName": "BuildClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/build.py" + }, + "537": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/build.py" + }, + "541": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/clients/resource_clients/build.py" + }, + "543": { + "qualifiedName": "abort", + "sourceFileName": "/src/apify_client/clients/resource_clients/build.py" + }, + "545": { + "qualifiedName": "wait_for_finish", + "sourceFileName": "/src/apify_client/clients/resource_clients/build.py" + }, + "548": { + "qualifiedName": "ActorVersionCollectionClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor_version_collection.py" + }, + "549": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor_version_collection.py" + }, + "553": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor_version_collection.py" + }, + "555": { + "qualifiedName": "create", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor_version_collection.py" + }, + "566": { + "qualifiedName": "ActorVersionClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor_version.py" + }, + "567": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor_version.py" + }, + "571": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor_version.py" + }, + "573": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor_version.py" + }, + "583": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor_version.py" + }, + "585": { + "qualifiedName": "ActorCollectionClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor_collection.py" + }, + "586": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor_collection.py" + }, + "590": { + "qualifiedName": "list", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor_collection.py" + }, + "596": { + "qualifiedName": "create", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor_collection.py" + }, + "614": { + "qualifiedName": "ActorClient", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor.py" + }, + "615": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor.py" + }, + "619": { + "qualifiedName": "get", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor.py" + }, + "621": { + "qualifiedName": "update", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor.py" + }, + "639": { + "qualifiedName": "delete", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor.py" + }, + "641": { + "qualifiedName": "start", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor.py" + }, + "650": { + "qualifiedName": "call", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor.py" + }, + "659": { + "qualifiedName": "build", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor.py" + }, + "666": { + "qualifiedName": "builds", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor.py" + }, + "668": { + "qualifiedName": "runs", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor.py" + }, + "670": { + "qualifiedName": "last_run", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor.py" + }, + "673": { + "qualifiedName": "versions", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor.py" + }, + "675": { + "qualifiedName": "version", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor.py" + }, + "678": { + "qualifiedName": "webhooks", + "sourceFileName": "/src/apify_client/clients/resource_clients/actor.py" + }, + "680": { + "qualifiedName": "ResourceCollectionClient", + "sourceFileName": "/src/apify_client/clients/base/resource_collection_client.py" + }, + "681": { + "qualifiedName": "ResourceClient", + "sourceFileName": "/src/apify_client/clients/base/resource_client.py" + }, + "682": { + "qualifiedName": "BaseClient", + "sourceFileName": "/src/apify_client/clients/base/base_client.py" + }, + "683": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/base/base_client.py" + }, + "691": { + "qualifiedName": "DEFAULT_WAIT_FOR_FINISH_SEC", + "sourceFileName": "/src/apify_client/clients/base/actor_job_base_client.py" + }, + "692": { + "qualifiedName": "DEFAULT_WAIT_WHEN_JOB_NOT_EXIST_SEC", + "sourceFileName": "/src/apify_client/clients/base/actor_job_base_client.py" + }, + "693": { + "qualifiedName": "ActorJobBaseClient", + "sourceFileName": "/src/apify_client/clients/base/actor_job_base_client.py" + }, + "694": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/base/base_client.py" + }, + "695": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/base/base_client.py" + }, + "696": { + "qualifiedName": "__init__", + "sourceFileName": "/src/apify_client/clients/base/base_client.py" + } + } +} \ No newline at end of file diff --git a/website/versioned_sidebars/version-0.6-sidebars.json b/website/versioned_sidebars/version-0.6-sidebars.json new file mode 100644 index 00000000..17f5c9af --- /dev/null +++ b/website/versioned_sidebars/version-0.6-sidebars.json @@ -0,0 +1,27 @@ +{ + "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": "doc", + "id": "changelog" + } + ] +} diff --git a/website/versions.json b/website/versions.json index 4ff37ab0..1b8739b1 100644 --- a/website/versions.json +++ b/website/versions.json @@ -1 +1 @@ -["2.5", "1.12"] +["2.5", "1.12", "0.6"] From b71c4cf0eb4d3a6f5ad5053903d6221d7737248a Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Tue, 14 Apr 2026 16:32:23 +0200 Subject: [PATCH 2/5] fix: correct SUCEEDED typo in v0.6 versioned docs Co-Authored-By: Claude Opus 4.6 (1M context) --- website/versioned_docs/version-0.6/api-typedoc.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/website/versioned_docs/version-0.6/api-typedoc.json b/website/versioned_docs/version-0.6/api-typedoc.json index 3cc3a954..7db94035 100644 --- a/website/versioned_docs/version-0.6/api-typedoc.json +++ b/website/versioned_docs/version-0.6/api-typedoc.json @@ -10027,7 +10027,7 @@ "args": { "wait_secs": "how long does the client wait for run to finish. None for indefinite.\n" }, - "returns": "dict, optional: The actor run data. If the status on the object is not one of the terminal statuses\n(SUCEEDED, FAILED, TIMED_OUT, ABORTED), then the run has not yet finished." + "returns": "dict, optional: The actor run data. If the status on the object is not one of the terminal statuses\n(SUCCEEDED, FAILED, TIMED_OUT, ABORTED), then the run has not yet finished." }, "sources": [ { @@ -10049,7 +10049,7 @@ "content": [ { "kind": "text", - "text": "dict, optional: The actor run data. If the status on the object is not one of the terminal statuses\n(SUCEEDED, FAILED, TIMED_OUT, ABORTED), then the run has not yet finished." + "text": "dict, optional: The actor run data. If the status on the object is not one of the terminal statuses\n(SUCCEEDED, FAILED, TIMED_OUT, ABORTED), then the run has not yet finished." } ], "tag": "@returns" @@ -16965,7 +16965,7 @@ "args": { "wait_secs": "how long does the client wait for build to finish. None for indefinite.\n" }, - "returns": "dict, optional: The actor build data. If the status on the object is not one of the terminal statuses\n(SUCEEDED, FAILED, TIMED_OUT, ABORTED), then the build has not yet finished." + "returns": "dict, optional: The actor build data. If the status on the object is not one of the terminal statuses\n(SUCCEEDED, FAILED, TIMED_OUT, ABORTED), then the build has not yet finished." }, "sources": [ { @@ -16987,7 +16987,7 @@ "content": [ { "kind": "text", - "text": "dict, optional: The actor build data. If the status on the object is not one of the terminal statuses\n(SUCEEDED, FAILED, TIMED_OUT, ABORTED), then the build has not yet finished." + "text": "dict, optional: The actor build data. If the status on the object is not one of the terminal statuses\n(SUCCEEDED, FAILED, TIMED_OUT, ABORTED), then the build has not yet finished." } ], "tag": "@returns" From e9b12a1f5c98fcfd5cc2b8374de72b0df156cd7d Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Tue, 14 Apr 2026 16:33:24 +0200 Subject: [PATCH 3/5] chore: extend typos spell checker exclusions for config files and changelogs Co-Authored-By: Claude Opus 4.6 (1M context) --- typos.toml | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/typos.toml b/typos.toml index d693a199..01da6375 100644 --- a/typos.toml +++ b/typos.toml @@ -13,7 +13,14 @@ extend-exclude = [ "*.lock", "*.min.js", "*.min.css", - "CHANGELOG.md", + "*.json", + "*.yaml", + "*.yml", + "*.toml", + "*.cfg", + "*.ini", + "**/CHANGELOG.md", + "**/changelog.md", ] [default.extend-words] From 5cf227d399405378319eff0b47b0a3e91f9a1498 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Tue, 14 Apr 2026 16:34:27 +0200 Subject: [PATCH 4/5] fix: remove overzealous config file exclusions from typos.toml Co-Authored-By: Claude Opus 4.6 (1M context) --- typos.toml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/typos.toml b/typos.toml index 01da6375..afde8a1a 100644 --- a/typos.toml +++ b/typos.toml @@ -13,12 +13,6 @@ extend-exclude = [ "*.lock", "*.min.js", "*.min.css", - "*.json", - "*.yaml", - "*.yml", - "*.toml", - "*.cfg", - "*.ini", "**/CHANGELOG.md", "**/changelog.md", ] From 1f90535045619866247361630aa06f43e0b4b6e4 Mon Sep 17 00:00:00 2001 From: Vlada Dusek Date: Tue, 14 Apr 2026 16:44:13 +0200 Subject: [PATCH 5/5] cleanup --- .gitignore | 1 + website/versioned_docs/version-0.6/.gitignore | 1 - website/versioned_docs/version-1.12/.gitignore | 1 - website/versioned_docs/version-2.5/.gitignore | 1 - 4 files changed, 1 insertion(+), 3 deletions(-) delete mode 100644 website/versioned_docs/version-0.6/.gitignore delete mode 100644 website/versioned_docs/version-1.12/.gitignore delete mode 100644 website/versioned_docs/version-2.5/.gitignore diff --git a/.gitignore b/.gitignore index 6cd3acfa..77add859 100644 --- a/.gitignore +++ b/.gitignore @@ -63,6 +63,7 @@ Session.vim # Docs docs/changelog.md +website/versioned_docs/*/changelog.md # Website build artifacts, node dependencies website/build diff --git a/website/versioned_docs/version-0.6/.gitignore b/website/versioned_docs/version-0.6/.gitignore deleted file mode 100644 index 1a13c363..00000000 --- a/website/versioned_docs/version-0.6/.gitignore +++ /dev/null @@ -1 +0,0 @@ -changelog.md diff --git a/website/versioned_docs/version-1.12/.gitignore b/website/versioned_docs/version-1.12/.gitignore deleted file mode 100644 index 1a13c363..00000000 --- a/website/versioned_docs/version-1.12/.gitignore +++ /dev/null @@ -1 +0,0 @@ -changelog.md diff --git a/website/versioned_docs/version-2.5/.gitignore b/website/versioned_docs/version-2.5/.gitignore deleted file mode 100644 index 1a13c363..00000000 --- a/website/versioned_docs/version-2.5/.gitignore +++ /dev/null @@ -1 +0,0 @@ -changelog.md